Merge "Apply reviewed doxygen header" into tizen_2.2

[platform/framework/native/appfw.git] / inc / FSecCryptoMd5Hmac.h

diff --git a/inc/FSecCryptoMd5Hmac.h b/inc/FSecCryptoMd5Hmac.h
index 0902938..04743d0 100644 (file)
--- a/inc/FSecCryptoMd5Hmac.h
+++ b/inc/FSecCryptoMd5Hmac.h
@@ -1,5 +1,4 @@
 //
-// Open Service Platform
 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
 //
 // Licensed under the Apache License, Version 2.0 (the License);
@@ -38,7 +37,8 @@ namespace Tizen { namespace Security { namespace Crypto
  *
  *     @since          2.0
  *
- *  The %Md5Hmac class implements the basic hash procedure to encrypt messages using the Hash Message Authentication Code (HMAC) algorithm, which provides a hash with a secret key. @n
+ *  The %Md5Hmac class implements the basic hash procedure to encrypt messages using the Hash Message Authentication Code (HMAC) 
+ *  algorithm, which provides a hash with a secret key.
  *
  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/security/hashing.htm">Hashing</a>.
  *
@@ -62,7 +62,7 @@ public:
        /**
         *      This destructor overrides Tizen::Base::Object::~Object().
         *
-        * @since               2.0
+        *      @since          2.0
         */
        virtual ~Md5Hmac(void);
 
@@ -74,18 +74,18 @@ public:
         *      @since          2.0
         *
         *      @return         An error code
-        *      @param[in]      algorithm                                       The name of the HMAC algorithm @n
+        *      @param[in]      algorithm                                       The HMAC algorithm name @n
         *                                                                                      For example, "HMACSHA2/224", "HMACSHA2/256", "HMACSHA2/384", or "HMACSHA2/512".
         *      @exception      E_SUCCESS                                       The method is successful.
         *      @exception      E_UNSUPPORTED_ALGORITHM         The algorithm is not supported.
-        *  @remarks    Do not call this method. It is not supported.
+        *      @remarks        Do not call this method. It is not supported.
         */
        virtual result SetAlgorithm(const Tizen::Base::String& algorithm);
 
        /**
         *      Sets the secret key.
         *
-        * @since               2.0
+        *      @since          2.0
         *
         *      @return         An error code
         *      @param[in]      key                                             An instance of ISecretKey
@@ -96,7 +96,7 @@ public:
        virtual result SetKey(const Tizen::Security::ISecretKey& key);
 
        /**
-        *      Gets the HMAC with the specified input.
+        *      Gets the HMAC for the specified input.
         *
         *      @since          2.0
         *
@@ -107,15 +107,16 @@ public:
         *      @exception      E_INVALID_ARG                   The input Tizen::Base::ByteBuffer is empty or contains invalid data.
         *      @exception      E_OUT_OF_MEMORY                 The memory is insufficient.
         *      @exception      E_KEY_NOT_FOUND                 The specified key is not found.
-        *      @exception      E_SYSTEM                                A system error has occurred. @n
-        *                                                                              The method has failed to operate with the OpenSSL library, or
-        *                                                                              the Tizen::Base::ByteBuffer operation has failed.
+        *      @exception      E_SYSTEM                                Either of the following conditions has occurred:
+        *                                                                              - A system error has occurred.
+        *                                                                              - The method has failed to operate with the OpenSSL library.
+        *                                                                              - The Tizen::Base::ByteBuffer operation has failed.
         *      @remarks        The specific error code can be accessed using the GetLastResult() method.
         */
        virtual Tizen::Base::ByteBuffer* GetHmacN(const Tizen::Base::ByteBuffer& input) const;
 
        /**
-        *      Initializes a multiple-part HMAC operation.
+        *      Initializes the multiple-part HMAC operation.
         *
         *      @since          2.0
         *
@@ -129,7 +130,7 @@ public:
        virtual result Initialize(void);
 
        /**
-        *      Updates a multiple-part HMAC operation while processing another data part.
+        *      Updates the multiple-part HMAC operation while processing another data part.
         *
         *      @since          2.0
         *
@@ -138,9 +139,10 @@ public:
         *      @exception      E_SUCCESS                               The method is successful.
         *      @exception      E_INVALID_ARG                   The input Tizen::Base::ByteBuffer is empty or contains invalid data.
         *      @exception      E_OUT_OF_MEMORY                 The memory is insufficient.
-        *      @exception      E_SYSTEM                                A system error has occurred. @n
-        *                                                                              The method has failed to operate with the OpenSSL library, or
-        *                                                                              the Tizen::Base::ByteBuffer operation has failed.
+        *      @exception      E_SYSTEM                                Either of the following conditions has occurred:
+        *                                                                              - A system error has occurred.
+        *                                                                              - The method has failed to operate with the OpenSSL library.
+        *                                                                              - The Tizen::Base::ByteBuffer operation has failed.
         */
        virtual result Update(const Tizen::Base::ByteBuffer& input);
 
@@ -153,9 +155,10 @@ public:
         *                              else @c null if an error occurs
         *      @exception      E_SUCCESS                               The method is successful.
         *      @exception      E_OUT_OF_MEMORY                 The memory is insufficient.
-        *      @exception      E_SYSTEM                                A system error has occurred. @n
-        *                                                                              The method has failed to operate with the OpenSSL library, or
-        *                                                                              the Tizen::Base::ByteBuffer operation has failed.
+        *      @exception      E_SYSTEM                                Either of the following conditions has occurred:
+        *                                                                              - A system error has occurred.
+        *                                                                              - The method has failed to operate with the OpenSSL library.
+        *                                                                              - The Tizen::Base::ByteBuffer operation has failed.
         *      @remarks        The specific error code can be accessed using the GetLastResult() method.
         */
        virtual Tizen::Base::ByteBuffer* FinalizeN(void);