//
-// Open Service Platform
// Copyright (c) 2013 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
/**
* @file FSecPkcsRc2CbcParameters.h
- * @brief This is the header file for the %PkcsRc2CbcParametersr class.
+ * @brief This is the header file for the %Rc2CbcParameters class.
*
- * This header file contains the declarations of the %PkcsRc2CbcParameters class.
+ * This header file contains the declarations of the %Rc2CbcParameters class.
*/
#ifndef _FSEC_PKCS_RC2_CBC_PARAMETERS_H_
/**
* @class Rc2CbcParameters
* @brief This class implements the functionalities specified by the Rc2 Cbc mode parameter.
- * @brief This class implements the functionalities specified by the Rc2 Cbc mode parameter.
+ *
+ * @since 2.1
+ *
+ * The %Rc2CbcParameters class implements the functionalities specified by the Rc2 Cbc mode parameter.
* This class represents the Rc2 cbc mode parameter for symmetric ciphers RC2.
* ASN.1 format for RC2-CBC-Parameter ::= SEQUENCE {
* rc2ParameterVersion INTEGER OPTIONAL,
* iv OCTET STRING (SIZE(8)) }
*
- * @since 2.1
- *
*/
class _OSP_EXPORT_ Rc2CbcParameters
*
* @since 2.1
*/
- virtual ~Rc2CbcParameters(void);
+ virtual ~Rc2CbcParameters();
/**
- * Initializes this instance of %Rc2CbcParameters with supplied input parameters values.
+ * Initializes this instance of %Rc2CbcParameters with the values of the specified input parameters.
*
* @since 2.1
*
* @return An error code
- * @param[in] initialVector An instance of ByteBuffer containing the initial vector.
- * @param[in] version An integer value defines the rc2 cbc parameter version.
- * As per Pkcs 5 standard, possible value can be 160,120,58 or any value
+ * @param[in] initialVector An instance of Tizen::Base::ByteBuffer containing the initial vector
+ * @param[in] version An integer value that defines the rc2 cbc parameter version @n
+ * As per Pkcs 5 standard, possible values can be 160,120,58, or any value
* greater than or equal to 256.
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
*/
result Construct(const Tizen::Base::ByteBuffer& initialVector, int version = 0);
/**
- * Get the copy of this instance.
+ * Gets a copy of this instance.
*
* @since 2.1
*
- * @return A pointer to IAlgorithmParameters, containing the copy of this instance.
+ * @return A pointer to IAlgorithmParameters, containing a copy of this instance
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
virtual IAlgorithmParameters* CloneN(void) const;
/**
- * Get the algorithm parameter type enum value for Rc2CbcParameters.
+ * Gets the algorithm parameter type enum value for %Rc2CbcParameters.
*
* @since 2.1
*
- * @return PkcsAlgorithmParameterType Enum value containing the PKCS_ALGO_PARAM_TYPE_RC2 value for Rc2CbcParameters parameter.
+ * @return An enum value containing the @c PKCS_ALGO_PARAM_TYPE_RC2 value for %Rc2CbcParameters parameter
*
*/
virtual PkcsAlgorithmParameterType GetType(void) const;
virtual int GetHashCode(void) const;
/**
- * Get the rc2 cbc parameter version value.
+ * Gets the rc2 cbc parameter version value.
*
* @since 2.1
*
- * @return An integer value that contains the rc2 cbc parameter version.
+ * @return An integer value that contains the rc2 cbc parameter version
*
*/
int GetVersion(void) const;
/**
- * Get the instance of byte buffer that contains the Initial Vector value.
+ * Gets an instance of Tizen::Base::ByteBuffer that contains the initial vector value.
*
* @since 2.1
*
- * @return A reference to ByteBuffer , containing the initial vector data.
+ * @return A reference to Tizen::Base::ByteBuffer containing the initial vector data
*
*/
const Tizen::Base::ByteBuffer& GetInitialVector(void) const;
/**
- * Gets the encoded form of the Rc2CbcParameter. @n
- * It is assumed that each Rc2CbcParameter type will have only a single form of encoding that is DER encoding.
+ * Gets the encoded form of %Rc2CbcParameters. @n
+ * It is assumed that each %Rc2CbcParameters type will have only a single form of encoding that is DER encoding.
*
* @since 2.1
*
- * @return Pointer to the DER encoded ByteBuffer, @n
- * else @c null if an error occurs.
+ * @return A pointer to the DER encoded Tizen::Base::ByteBuffer, @n
+ * else @c null if an error occurs
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
projects / platform / framework / native / appfw.git / blobdiff