update doxygen comments

Change-Id: Ic6cd08ae0f22a64c2a55870e93a809e5c3874e89
Signed-off-by: KyungwooNoh <kw1004.noh@samsung.com>

diff --git a/inc/FSecCryptoIHmac.h b/inc/FSecCryptoIHmac.h
old mode 100644 (file)
new mode 100755 (executable)
index 5f57983..cf0b03f
--- a/inc/FSecCryptoIHmac.h
+++ b/inc/FSecCryptoIHmac.h
@@ -324,7 +324,7 @@ public:
        virtual result SetKey(const Tizen::Security::ISecretKey& key) = 0;
 
        /**
-        *      Gets the HMAC with the given input.
+        *      Gets the HMAC with a given input.
         *
         *      @since                  2.0
         *
@@ -342,7 +342,7 @@ public:
        virtual Tizen::Base::ByteBuffer* GetHmacN(const Tizen::Base::ByteBuffer& input) const = 0;
 
        /**
-        *      Initializes the multiple-part HMAC operation.
+        *      Initializes a multiple-part HMAC operation.
         *
         *      @since          2.0
         *

diff --git a/inc/FSecCryptoISignature.h b/inc/FSecCryptoISignature.h
old mode 100644 (file)
new mode 100755 (executable)
index 53d0684..10a7cbd
--- a/inc/FSecCryptoISignature.h
+++ b/inc/FSecCryptoISignature.h
@@ -184,7 +184,7 @@ public:
         *
         *      @since          2.0
         *
-        *      @return         A pointer to the Tizen::Base::ByteBuffer that contains the output, @n
+        *      @return         A pointer to the Tizen::Base::ByteBuffer instance that contains the output, @n
         *                              else @c null if an error occurs
         *      @param[in]      input                                           An instance of Tizen::Base::ByteBuffer
         *      @exception      E_SUCCESS                                       The method is successful.

diff --git a/inc/FSecKeyPairGenerator.h b/inc/FSecKeyPairGenerator.h
old mode 100644 (file)
new mode 100755 (executable)
index 150b20e..5310053
--- a/inc/FSecKeyPairGenerator.h
+++ b/inc/FSecKeyPairGenerator.h
@@ -136,7 +136,7 @@ public:
         *                                                                              These parameters are instantiated.
         *      @exception      E_SUCCESS                               The method is successful.
         *      @exception      E_OUT_OF_MEMORY                 The memory is insufficient.
-        *      @exception      E_SYSTEM                                The method cannot proceed due to a severe system error.@n
+        *      @exception      E_SYSTEM                                The method cannot proceed due to a severe system error. @n
         *                                                                              The method has failed to operate with the OpenSSL library, or the Tizen::Base::ByteBuffer operation has failed.
         *      @remarks        The specific error code can be accessed using the GetLastResult() method.
         */

diff --git a/inc/FSecPkcsAlgorithmIdentifier.h b/inc/FSecPkcsAlgorithmIdentifier.h
index 09b73ce..109aae3 100755 (executable)
--- a/inc/FSecPkcsAlgorithmIdentifier.h
+++ b/inc/FSecPkcsAlgorithmIdentifier.h
@@ -92,7 +92,7 @@ public:
        result Construct(const Tizen::Base::String& objectId, const IAlgorithmParameters* pParams = null);
 
        /**
-        * Initializes this instance of %AlgorithmIdentifier with the DER encoded Tizen::Base::Bytebuffer that conatins @n
+        * Initializes this instance of %AlgorithmIdentifier with the DER encoded Tizen::Base::ByteBuffer that contains @n
         * the ASN.1 specified %AlgorithmIdentifier structure.
         *
         * @since               2.1

diff --git a/inc/FSecPkcsPkcs05PbEs2Parameters.h b/inc/FSecPkcsPkcs05PbEs2Parameters.h
index cf86947..beb4184 100755 (executable)
--- a/inc/FSecPkcsPkcs05PbEs2Parameters.h
+++ b/inc/FSecPkcsPkcs05PbEs2Parameters.h
@@ -77,12 +77,12 @@ public:
        virtual ~Pkcs05PbEs2Parameters(void);
 
        /**
-        * Initializes this instance of %Pkcs05PbEs2Parameters with the encoded Tizen::Base::Bytebuffer, which contain Password Based Encryption Parameters Structure(PBES2) in ASN.1 DER format.
+        * Initializes this instance of %Pkcs05PbEs2Parameters with the encoded Tizen::Base::ByteBuffer, which contain Password Based Encryption Parameters Structure(PBES2) in ASN.1 DER format.
         *
         * @since               2.1
         *
         * @return              An error code
-        * @param[in]   encodedData                             DER encoded Tizen::Base::Bytebuffer containing %Pkcs05PbEs2Parameters
+        * @param[in]   encodedData                             The DER encoded Tizen::Base::ByteBuffer containing %Pkcs05PbEs2Parameters
         * @exception   E_SUCCESS                                       The method is successful.
         * @exception   E_INVALID_ARG                   The specified input parameter is invalid.
         */

diff --git a/inc/FSecPkcsPkcs05PbKdf2Parameters.h b/inc/FSecPkcsPkcs05PbKdf2Parameters.h
index 9285bb9..2a8d1eb 100755 (executable)
--- a/inc/FSecPkcsPkcs05PbKdf2Parameters.h
+++ b/inc/FSecPkcsPkcs05PbKdf2Parameters.h
@@ -80,7 +80,7 @@ public:
        virtual ~Pkcs05PbKdf2Parameters(void);
 
        /**
-        * Initializes this instance of %Pkcs05PbKdf2Parameters with the encoded Tizen::Base::Bytebuffer that contains Password Based Key Derivation Function parameters structure(PBKDF2) in ASN.1 DER format.
+        * Initializes this instance of %Pkcs05PbKdf2Parameters with the encoded Tizen::Base::ByteBuffer that contains Password Based Key Derivation Function parameters structure(PBKDF2) in ASN.1 DER format.
          *
         * @since               2.1
         *

diff --git a/inc/FSecPkcsPkcs05PbMacParameters.h b/inc/FSecPkcsPkcs05PbMacParameters.h
index 369dece..dc073cd 100755 (executable)
--- a/inc/FSecPkcsPkcs05PbMacParameters.h
+++ b/inc/FSecPkcsPkcs05PbMacParameters.h
@@ -77,7 +77,7 @@ public:
 
        /**
         * Initializes this instance of %Pkcs05PbMacParameters with the Tizen::Base::ByteBuffer instance that contains Password Based Message  @n
-        * Authentication Cyrptography parameters structure(PBMAC1) in ASN.1 DER format.
+        * Authentication Cryptography parameters structure(PBMAC1) in ASN.1 DER format.
         *
         * @since               2.1
         *

diff --git a/inc/FSecPkcsPkcs08Attribute.h b/inc/FSecPkcsPkcs08Attribute.h
index 468e94c..9f524db 100755 (executable)
--- a/inc/FSecPkcsPkcs08Attribute.h
+++ b/inc/FSecPkcsPkcs08Attribute.h
@@ -64,20 +64,20 @@ public:
        virtual ~Pkcs08Attribute(void);
 
        /**
-        * Intializes this instance of %Pkcs08Attribute with the Tizen::Base::Bytebuffer that contains the X.509 attribute @n
+        * Initializes this instance of %Pkcs08Attribute with the Tizen::Base::ByteBuffer that contains the X.509 attribute @n
         * structure in ASN.1 DER format.
         *
         * @since               2.1
         *
         * @return              An error code
-        * @param[in]   encodedData                             The DER encoded Bytebuffer containing the X.509 attribute structure
+        * @param[in]   encodedData                             The DER encoded Tizen::Base::ByteBuffer containing the X.509 attribute structure
         * @exception   E_SUCCESS                                       The method is successful.
         * @exception   E_INVALID_ARG                   The specified input parameter is invalid.
         */
        result Construct(const Tizen::Base::ByteBuffer& encodedData);
 
        /**
-        * Intializes this instance of %Pkcs08Attribute with the specified attribute type.
+        * Initializes this instance of %Pkcs08Attribute with the specified attribute type.
         *
         * @since               2.1
         *

diff --git a/inc/FSecPkcsPkcs08AttributeValue.h b/inc/FSecPkcsPkcs08AttributeValue.h
index 865d2f1..64d36a5 100755 (executable)
--- a/inc/FSecPkcsPkcs08AttributeValue.h
+++ b/inc/FSecPkcsPkcs08AttributeValue.h
@@ -62,20 +62,20 @@ public:
        virtual ~Pkcs08AttributeValue(void);
 
        /**
-        * Intializes this instance of %Pkcs08AttributeValue with the Tizen::Base::Bytebuffer that contains the AttributeValue @n
+        * Initializes this instance of %Pkcs08AttributeValue with the Tizen::Base::ByteBuffer that contains the AttributeValue @n
         * (contain tag, that is, Ans1_Type and the value).
         *
         * @since               2.1
         *
         * @return              An error code
-        * @param[in]   encodedData                             The DER encoded Tizen::Base::Bytebuffer of AttributeValue
+        * @param[in]   encodedData                             The DER encoded Tizen::Base::ByteBuffer of AttributeValue
         * @exception   E_SUCCESS                                       The method is successful.
         * @exception   E_INVALID_ARG                   The specified input parameter is invalid.
         */
        result Construct(const Tizen::Base::ByteBuffer& encodedData);
 
        /**
-        * Intializes this instance of %Pkcs08AttributeValue with the specified parameters. @n
+        * Initializes this instance of %Pkcs08AttributeValue with the specified parameters. @n
         * The %Construct() method initializes the attribute value instance based on the byte buffer passed.
         *
         * @since               2.1

diff --git a/inc/FSecPkcsPkcs08EncryptedPrivateKeyInfo.h b/inc/FSecPkcsPkcs08EncryptedPrivateKeyInfo.h
index c83ea4c..6c132f7 100755 (executable)
--- a/inc/FSecPkcsPkcs08EncryptedPrivateKeyInfo.h
+++ b/inc/FSecPkcsPkcs08EncryptedPrivateKeyInfo.h
@@ -69,13 +69,13 @@ public:
        virtual ~Pkcs08EncryptedPrivateKeyInfo(void);
 
        /**
-        * Initializes this instance of %Pkcs08EncryptedPrivateKeyInfo with the encoded Tizen::Base::Bytebuffer that contains  @n
+        * Initializes this instance of %Pkcs08EncryptedPrivateKeyInfo with the encoded Tizen::Base::ByteBuffer that contains  @n
         * the EncryptedPrivateKeyInfo structure(EncryptedPrivateKeyInfo) in ASN.1 DER format.
         *
         * @since               2.1
         *
         * @return              An error code
-        * @param[in]   encodedData                                     The DER encoded Tizen::Base::Bytebuffer that contains the Pkcs08 EncryptedPrivateKeyInfo structure
+        * @param[in]   encodedData                                     The DER encoded Tizen::Base::ByteBuffer that contains the Pkcs08 EncryptedPrivateKeyInfo structure
         * @exception   E_SUCCESS                                               The method is successful.
         * @exception   E_INVALID_ARG                           The specified input parameter is invalid.
         */

diff --git a/inc/FSecPkcsPkcs08PrivateKeyInfo.h b/inc/FSecPkcsPkcs08PrivateKeyInfo.h
index 937494f..3d7dc6c 100755 (executable)
--- a/inc/FSecPkcsPkcs08PrivateKeyInfo.h
+++ b/inc/FSecPkcsPkcs08PrivateKeyInfo.h
@@ -76,12 +76,12 @@ public:
        /**
         * Initializes this instance of %Pkcs08PrivateKeyInfo with the encoded byte buffer that contains  @n
         * pkcs08 private key info structure(PrivateKeyInfo) in ASN.1 DER format. @n
-        * It parses this encoded buffer and extracts the appropiate values of private key, its algorithm ID, and attributes.
+        * It parses this encoded buffer and extracts the appropriate values of private key, its algorithm ID, and attributes.
         *
         * @since               2.1
         *
         * @return              An error code
-        * @param[in]   encodedData                                     An instance of Tizen::Base::Bytebuffer containing DER encoded PrivateKeyInfo structure
+        * @param[in]   encodedData                                     An instance of Tizen::Base::ByteBuffer containing DER encoded PrivateKeyInfo structure
         * @exception   E_SUCCESS                                               The method is successful.
         * @exception   E_INVALID_ARG                           The specified input parameter is invalid.
         */

diff --git a/inc/FSecPkcsTypes.h b/inc/FSecPkcsTypes.h
index f5bcec6..5f098ec 100755 (executable)
--- a/inc/FSecPkcsTypes.h
+++ b/inc/FSecPkcsTypes.h
@@ -95,7 +95,7 @@ enum Pkcs08TagValue
 _OSP_EXPORT_ extern const wchar_t OID_PKCS_05[];    /**< An object identifier for pkcs05 */
 _OSP_EXPORT_ extern const wchar_t OID_PBKDF2[];  /**< An object identifier for password based key derivation function scheme2 */
 _OSP_EXPORT_ extern const wchar_t OID_PBES2[];   /**< An object identifier for password based encryption scheme2 */
-_OSP_EXPORT_ extern const wchar_t OID_PBMAC1[];  /**< An object identifier for password based message authetication scheme1 */
+_OSP_EXPORT_ extern const wchar_t OID_PBMAC1[];  /**< An object identifier for password based message authentication scheme1 */
 _OSP_EXPORT_ extern const wchar_t OID_HMAC_SHA1[];  /**< An object identifier for hmac-sha1 */
 _OSP_EXPORT_ extern const wchar_t OID_HMAC_SHA2_224[];  /**< An object identifier for hmac-sha224 */
 _OSP_EXPORT_ extern const wchar_t OID_HMAC_SHA2_256[];  /**< An object identifier for hmac-sha256 */
@@ -115,23 +115,23 @@ _OSP_EXPORT_ extern const wchar_t OID_RSA_ENCRYPTION[];   /**< An object identif
 -- Basic object identifiers in Pkcs08 for AttributeType
 */
 
-_OSP_EXPORT_ extern const wchar_t OID_ATTR_NAME[];  /**< object identifier for attribute type name. */
-_OSP_EXPORT_ extern const wchar_t OID_ATTR_SURNAME[];    /**< object identifier for attribute type surname. */
-_OSP_EXPORT_ extern const wchar_t OID_ATTR_GIVEN_NAME[]; /**< object identifier for attribute type of any given name. */
-_OSP_EXPORT_ extern const wchar_t OID_ATTR_INITIAL[];   /**< object identifier for attribute type initial. */
-_OSP_EXPORT_ extern const wchar_t OID_ATTR_GEN_QUALIFIER[];  /**< object identifier for attribute type generation qualifier. */
-_OSP_EXPORT_ extern const wchar_t OID_ATTR_COMMON_NAME[]; /**< object identifier for attribute type common name. */
-_OSP_EXPORT_ extern const wchar_t OID_ATTR_LOCALITY_NAME[];  /**< object identifier for attribute type locality name. */
-_OSP_EXPORT_ extern const wchar_t OID_ATTR_STATE_OR_PROV_NAME[];   /**< object identifier for attribute type state/province name. */
-_OSP_EXPORT_ extern const wchar_t OID_ATTR_ORG_NAME[]; /**< object identifier for attribute type of any orgnization name. */
-_OSP_EXPORT_ extern const wchar_t OID_ATTR_ORG_UNIT_NAME[];    /**< object identifier for any orgnization unit name. */
-_OSP_EXPORT_ extern const wchar_t OID_ATTR_TITLE[]; /**< object identifier for attribute type title. */
-_OSP_EXPORT_ extern const wchar_t OID_ATTR_DN_QUALIFIER[];   /**< object identifier for distinguished name qualifier. */
-_OSP_EXPORT_ extern const wchar_t OID_ATTR_COUNTRY_NAME[];    /**< object identifier for attribute type country name. */
-_OSP_EXPORT_ extern const wchar_t OID_ATTR_SERIAL_NUMBER[];   /**< object identifier for attribute type serial number. */
-_OSP_EXPORT_ extern const wchar_t OID_ATTR_PSEUDONYM[]; /**< object identifier for attribute type pseudonym. */
-_OSP_EXPORT_ extern const wchar_t OID_ATTR_DOMAIN_COMPONENT[]; /**< object identifier for any domain component. */
-_OSP_EXPORT_ extern const wchar_t OID_ATTR_EMAIL_ADDRESS[];  /**< object identifier for any email address. */
+_OSP_EXPORT_ extern const wchar_t OID_ATTR_NAME[];  /**< An object identifier for attribute type name */
+_OSP_EXPORT_ extern const wchar_t OID_ATTR_SURNAME[];    /**< An object identifier for attribute type surname */
+_OSP_EXPORT_ extern const wchar_t OID_ATTR_GIVEN_NAME[]; /**< An object identifier for attribute type of any given name */
+_OSP_EXPORT_ extern const wchar_t OID_ATTR_INITIAL[];   /**< An object identifier for attribute type initial */
+_OSP_EXPORT_ extern const wchar_t OID_ATTR_GEN_QUALIFIER[];  /**< An object identifier for attribute type generation qualifier */
+_OSP_EXPORT_ extern const wchar_t OID_ATTR_COMMON_NAME[]; /**< An object identifier for attribute type common name */
+_OSP_EXPORT_ extern const wchar_t OID_ATTR_LOCALITY_NAME[];  /**< An object identifier for attribute type locality name */
+_OSP_EXPORT_ extern const wchar_t OID_ATTR_STATE_OR_PROV_NAME[];   /**< An object identifier for attribute type state/province name */
+_OSP_EXPORT_ extern const wchar_t OID_ATTR_ORG_NAME[]; /**< An object identifier for attribute type of any organization name */
+_OSP_EXPORT_ extern const wchar_t OID_ATTR_ORG_UNIT_NAME[];    /**< An object identifier for any organization unit name */
+_OSP_EXPORT_ extern const wchar_t OID_ATTR_TITLE[]; /**< An object identifier for attribute type title */
+_OSP_EXPORT_ extern const wchar_t OID_ATTR_DN_QUALIFIER[];   /**< An object identifier for distinguished name qualifier */
+_OSP_EXPORT_ extern const wchar_t OID_ATTR_COUNTRY_NAME[];    /**< An object identifier for attribute type country name */
+_OSP_EXPORT_ extern const wchar_t OID_ATTR_SERIAL_NUMBER[];   /**< An object identifier for attribute type serial number */
+_OSP_EXPORT_ extern const wchar_t OID_ATTR_PSEUDONYM[]; /**< An object identifier for attribute type pseudonym */
+_OSP_EXPORT_ extern const wchar_t OID_ATTR_DOMAIN_COMPONENT[]; /**< An object identifier for any domain component */
+_OSP_EXPORT_ extern const wchar_t OID_ATTR_EMAIL_ADDRESS[];  /**< An object identifier for any email address */
 
 } } } // Tizen::Security::Pkcs