//
-// Open Service Platform
// Copyright (c) 2013 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
/**
* @interface IAlgorithmParameters
- * @brief This is an interface class for cryptographic algorithm parameters like IV etc. It provides the generic
- * functionalities which must be supported by all derived algorithm parameters like PbKdf2Parameters, PbEs2Parameters.
- * This is an abstract class and hence object of this class cannot be instantiated.
+ * @brief This interface is an interface class for cryptographic algorithm parameters such as IV. It provides the generic
+ * functionalities that must be supported by all the derived algorithm parameters such PbKdf2Parameters, PbEs2Parameters.
+ *
* @since 2.1
*
+ * The %IAlgorithmParameters interface is an interface class for cryptographic algorithm parameters such as IV. It provides the generic
+ * functionalities that must be supported by all derived algorithm parameters such PbKdf2Parameters, PbEs2Parameters.
+ * This is an abstract class and hence, object of this class cannot be instantiated.
+ *
*/
class _OSP_EXPORT_ IAlgorithmParameters
{
public:
/**
- * This polymorphic destructor should be overridden if required. This way, @n
- * the destructors of the derived classes are called when the destructor of this interface is called.
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.1
*/
virtual ~IAlgorithmParameters(void) {}
/**
- * Get the copy of parameters of the specified algorithm type.
+ * Gets the copy of the parameters of the specified algorithm type.
*
- * @since 2.1
+ * @since 2.1
*
- * @return Pointer to AlgorithmParameters, containing the instance of algorithm parameter , @n
- * else @c null if an error occurs.
+ * @return A pointer to AlgorithmParameters, containing the instance of algorithm parameter , @n
+ * else @c null if an error occurs
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
virtual IAlgorithmParameters* CloneN(void) const = 0;
/**
- * Get the pkcs algorithm parameter type enumerated value.
+ * Gets the PKCS algorithm parameter type enumerated value.
*
- * @since 2.1
+ * @since 2.1
*
- * @return PkcsAlgorithmParamterType, containing the enumerated value of PkcsAlgorithmParameterType.
+ * @return The type containing the enumerated value of PkcsAlgorithmParameterType
*
*/
virtual PkcsAlgorithmParameterType GetType(void) const = 0;
//
// This method is reserved and may change its name at any time without prior notice.
//
- // @since 2.1
+ // @since 2.1
//
virtual void IAlgorithmParameters_Reserved1(void) {}
//
// This method is reserved and may change its name at any time without prior notice.
//
- // @since 2.1
+ // @since 2.1
//
virtual void IAlgorithmParameters_Reserved2(void) {}
//
// This method is reserved and may change its name at any time without prior notice.
//
- // @since 2.1
+ // @since 2.1
//
virtual void IAlgorithmParameters_Reserved3(void) {}