Apply reviewed doxygen header

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

diff --git a/inc/FSecCryptoIAsymmetricCipher.h b/inc/FSecCryptoIAsymmetricCipher.h
index aff8197..855ed69 100644 (file)
--- a/inc/FSecCryptoIAsymmetricCipher.h
+++ b/inc/FSecCryptoIAsymmetricCipher.h
@@ -36,7 +36,7 @@ namespace Tizen { namespace Security { namespace Crypto
 
 /**
  *     @interface      IAsymmetricCipher
- *     @brief          This interface provides the functionality of an asymmetric cryptographic cipher for encryption and decryption.
+ *     @brief          This interface provides methods for the functionality of an asymmetric cryptographic cipher for encryption and decryption.
  *
  *     @since          2.0
  *
@@ -163,7 +163,7 @@ public:
        virtual ~IAsymmetricCipher(void) {}
 
        /**
-        *      Sets an asymmetric private key for encryption or decryption.
+        *      Sets the asymmetric private key for encryption or decryption.
         *
         *      @since          2.0
         *
@@ -176,7 +176,7 @@ public:
        virtual result SetPrivateKey(const Tizen::Security::IKey& key) = 0;
 
        /**
-        *      Sets an asymmetric public key for encryption or decryption.
+        *      Sets the asymmetric public key for encryption or decryption.
         *
         *      @since          2.0
         *
@@ -193,7 +193,7 @@ public:
         *
         *      @since          2.0
         *
-        *      @return         A pointer to the Tizen::Base::ByteBuffer class 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.
@@ -201,9 +201,10 @@ public:
         *      @exception      E_OUT_OF_MEMORY                         The memory is insufficient.
         *      @exception      E_UNSUPPORTED_ALGORITHM         The algorithm is not supported.
         *      @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.n
+        *                                                                                      - The method has failed to operate with the openssl library.
+        *                                                                                      - The Tizen::Base::ByteBuffer operation has failed.
         */
        virtual Tizen::Base::ByteBuffer* EncryptN(const Tizen::Base::ByteBuffer& input) = 0;
 
@@ -212,7 +213,7 @@ public:
         *
         *      @since          2.0
         *
-        *      @return         A pointer to the Tizen::Base::ByteBuffer class 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.
@@ -220,9 +221,10 @@ public:
         *      @exception      E_OUT_OF_MEMORY                         The memory is insufficient.
         *      @exception      E_UNSUPPORTED_ALGORITHM         The algorithm is not supported.
         *      @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.
         */
        virtual Tizen::Base::ByteBuffer* DecryptN(const Tizen::Base::ByteBuffer& input) = 0;