update header for Doxygen

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

diff --git a/inc/FSecCryptoDesCipher.h b/inc/FSecCryptoDesCipher.h
index dc6ef64..a875a01 100644 (file)
--- a/inc/FSecCryptoDesCipher.h
+++ b/inc/FSecCryptoDesCipher.h
@@ -40,7 +40,7 @@ class _SymmetricCipher;
  *
  *     The %DesCipher class provides a symmetric cipher using the Data Encryption Standard (DES) method.
  *     Sets appropriate values for the requested mode/key bit/padding scheme and cipher operation mode
- * (CIPHER_ENCRYPT or CIPHER_DECRYPT) parameters. @n
+ * (::CIPHER_ENCRYPT or ::CIPHER_DECRYPT) parameters. @n
  *
  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/security/ciphers.htm">Ciphers</a>.
  *
@@ -117,7 +117,7 @@ public:
         *      Encrypts the data (single-part).
         *
         *      @since          2.0
-        *
+        *      @pre                    Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector().
         *      @return         A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n
         *                              else @c null if an error occurs
         *      @param[in]      input                                           An instance of Tizen::Base::ByteBuffer
@@ -130,8 +130,7 @@ public:
         *      @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.
-        *      @remarks        A secret key and an initial vector are set before calling this method.
+        *      @remarks                The specific error code can be accessed using the GetLastResult() method.
         */
        virtual Tizen::Base::ByteBuffer* EncryptN(const Tizen::Base::ByteBuffer& input);
 
@@ -139,7 +138,7 @@ public:
         *      Decrypts the data (single-part).
         *
         *      @since          2.0
-        *
+        *      @pre                    Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector().
         *      @return         A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n
         *                              else @c null if an error occurs
         *  @param[in]  input                                           An instance of Tizen::Base::ByteBuffer
@@ -152,16 +151,15 @@ public:
         *      @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.
-        * @remarks     A secret key and an initial vector are set before calling this method.
+        *  @remarks            The specific error code can be accessed using the GetLastResult() method.
         */
        virtual Tizen::Base::ByteBuffer* DecryptN(const Tizen::Base::ByteBuffer& input);
 
        /**
         *      Initializes a multiple-part encryption or decryption operation.
         *
-        * @since               2.0
-        *
+        *      @since          2.0
+        *      @pre                    Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector().
         *      @return         An error code
         *      @exception      E_SUCCESS                                       The method is successful.
         *      @exception      E_OUT_OF_MEMORY                         The memory is insufficient.
@@ -169,7 +167,6 @@ public:
         *      @exception      E_INVALID_OPERATION                     The specified cipher operation mode for this method is invalid.
         *      @exception      E_SYSTEM                                        A system error has occurred. @n
         *                                                                                      The method has failed to operate with the openssl library.
-        *      @remarks        A secret key and an initial vector are set before calling this method.
         */
        virtual result Initialize(void);
 
@@ -217,9 +214,10 @@ public:
         *      @return         A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n
         *                              else @c null if an error occurs
         *      @param[in]      secretKey                               The secret key to wrap
-        *      @remarks        This operation is not supported in the %DesCipher class.
-        *                              Therefore, this method always returns @c null.
-        *      @remarks        The @c E_UNSUPPORTED_ALGORITHM exception is returned using the GetLastResult() method.
+        *      @remarks        
+        *                      - This operation is not supported in the %DesCipher class.
+        *                      Therefore, this method always returns @c null.
+        *                      - The @c E_UNSUPPORTED_ALGORITHM exception is returned using the GetLastResult() method.
         */
        virtual Tizen::Base::ByteBuffer* WrapN(const Tizen::Base::ByteBuffer& secretKey);
 
@@ -231,9 +229,10 @@ public:
         *      @return         A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n
         *                              else @c null if an error occurs
         *      @param[in]      wrappedKey                              The wrapped key to unwrap
-        *      @remarks        This operation is not supported in the %DesCipher class.
-        *                              Therefore, this method always returns @c null.
-        *      @remarks        The @c E_UNSUPPORTED_ALGORITHM exception is returned using the GetLastResult() method.
+        *      @remarks        
+        *                      - This operation is not supported in the %DesCipher class.
+        *                      Therefore, this method always returns @c null.
+        *                      - The @c E_UNSUPPORTED_ALGORITHM exception is returned using the GetLastResult() method.
         */
        virtual Tizen::Base::ByteBuffer* UnwrapN(const Tizen::Base::ByteBuffer& wrappedKey);