Apply reviewed doxygen header

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

diff --git a/inc/FSecCryptoIHmac.h b/inc/FSecCryptoIHmac.h
old mode 100644 (file)
new mode 100755 (executable)
index 5f57983..241639b
--- a/inc/FSecCryptoIHmac.h
+++ b/inc/FSecCryptoIHmac.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);
@@ -290,8 +289,8 @@ class _OSP_EXPORT_ IHmac
 
 public:
        /**
-        * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n
-        * are called when the destructor of this interface is called.
+        * This polymorphic destructor should be overridden if required. @n 
+        * This way, the destructors of the derived classes are called when the destructor of this interface is called.
         *
         *      @since          2.0
         */
@@ -303,7 +302,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 @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.
@@ -324,9 +323,9 @@ public:
        virtual result SetKey(const Tizen::Security::ISecretKey& key) = 0;
 
        /**
-        *      Gets the HMAC with the given input.
+        *      Gets the HMAC for the specified input.
         *
-        *      @since                  2.0
+        *      @since          2.0
         *
         *      @return         A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n
         *                              else @c null if an error occurs
@@ -335,9 +334,10 @@ 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 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.
         */
        virtual Tizen::Base::ByteBuffer* GetHmacN(const Tizen::Base::ByteBuffer& input) const = 0;
 
@@ -350,13 +350,14 @@ public:
         *      @exception      E_SUCCESS                               The method is successful.
         *      @exception      E_OUT_OF_MEMORY                 The memory is insufficient.
         *      @exception      E_KEY_NOT_FOUND                 The 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) = 0;
 
        /**
-        *      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
         *
@@ -365,24 +366,26 @@ 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) = 0;
 
        /**
-        *      Finalizes a multiple-part HMAC operation.
+        *      Finalizes the multiple-part HMAC operation.
         *
         *      @since          2.0
         *
         *      @return         A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n
-        *                                      else @c null if an error occurs
+        *                              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.
         */
        virtual Tizen::Base::ByteBuffer* FinalizeN(void) = 0;