Apply reviewed doxygen header

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

diff --git a/inc/FSecCryptoSha1Hmac.h b/inc/FSecCryptoSha1Hmac.h
index 33febd9..1f814d3 100644 (file)
--- a/inc/FSecCryptoSha1Hmac.h
+++ b/inc/FSecCryptoSha1Hmac.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);
@@ -40,7 +39,7 @@ namespace Tizen { namespace Security { namespace Crypto
  *
  *     The %Sha1Hmac class implements the SHA-1 HMAC algorithm. @n
  *
- *  For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/security/hashing.htm">Hashing</a>.
+ *     For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/security/hashing.htm">Hashing</a>.
  *
  *     @see    IHmac
  *     @see    Md5Hmac
@@ -55,14 +54,14 @@ public:
        /**
         *      This is the default constructor for this class.
         *
-        * @since               2.0
+        *      @since          2.0
         */
        Sha1Hmac(void);
 
        /**
-        * This destructor overrides Tizen::Base::Object::~Object().
+        *      This destructor overrides Tizen::Base::Object::~Object().
         *
-        * @since               2.0
+        *      @since          2.0
         */
        virtual ~Sha1Hmac(void);
 
@@ -74,7 +73,7 @@ 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.
@@ -96,7 +95,7 @@ public:
        virtual result SetKey(const Tizen::Security::ISecretKey& key);
 
        /**
-        *      Gets HMAC with the given input.
+        *      Gets the HMAC for the specified input.
         *
         *      @since          2.0
         *
@@ -107,14 +106,15 @@ 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.
+        *      @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.
         *      @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
         *
@@ -122,13 +122,14 @@ public:
         *      @exception      E_SUCCESS                               The method is successful.
         *      @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.
+        *      @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.
         */
        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
         *
@@ -137,14 +138,15 @@ 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);
 
        /**
-        *      Finalizes a multiple-part HMAC operation.
+        *      Finalizes the multiple-part HMAC operation.
         *
         *      @since          2.0
         *
@@ -152,10 +154,11 @@ 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.
-        *      @remarks    The specific error code can be accessed using the GetLastResult() method.
+        *      @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);