Revert "Revert "Fix intApp TC failure""

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

diff --git a/inc/FSecCryptoSha2Hash.h b/inc/FSecCryptoSha2Hash.h
index 705db99..12910fb 100755 (executable)
--- a/inc/FSecCryptoSha2Hash.h
+++ b/inc/FSecCryptoSha2Hash.h
@@ -39,7 +39,7 @@ namespace Tizen { namespace Security { namespace Crypto
  *
  *     The %Sha2Hash class implements the SHA-2 hash 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            Tizen::Security::Crypto::IHash
  *     @see            Tizen::Security::Crypto::Md5Hash
@@ -59,7 +59,7 @@ public:
        Sha2Hash(void);
 
        /**
-        * This destructor overrides Tizen::Base::Object::~Object().
+        *      This destructor overrides Tizen::Base::Object::~Object().
         *
         *      @since          2.0
         */
@@ -71,7 +71,7 @@ public:
         *      @since          2.0
         *
         *      @return         An error code
-        *      @param[in]      algorithm                               The name of the hash algorithm @n
+        *      @param[in]      algorithm                               The hash algorithm name @n
         *                                                                              For example, "SHA2/224", "SHA2/256", "SHA2/384", or "SHA2/512".
         *      @exception      E_SUCCESS                               The method is successful.
         *      @exception      E_UNSUPPORTED_ALGORITHM The algorithm is not supported.
@@ -79,7 +79,7 @@ public:
        virtual result SetAlgorithm(const Tizen::Base::String& algorithm);
 
        /**
-        *      Gets the hashes of the data (single-part).
+        *      Gets the hashes of the specified data (single-part).
         *
         *      @since          2.0
         *
@@ -89,28 +89,30 @@ 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.
         *      @remarks        The specific error code can be accessed using the GetLastResult() method.
         */
        virtual Tizen::Base::ByteBuffer* GetHashN(const Tizen::Base::ByteBuffer& input) const;
 
        /**
-        *      Initializes a multiple-part hash operation.
+        *      Initializes the multiple-part hash operation.
         *
         *      @since          2.0
         *
         *      @return         An error code
         *      @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.
+        *      @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 hash operation while processing another data part.
+        *      Updates the multiple-part hash operation while processing another data part.
         *
         *      @since          2.0
         *
@@ -119,14 +121,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 hash operation.
+        *      Finalizes the multiple-part hash operation.
         *
         *      @since          2.0
         *
@@ -134,9 +137,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);