Revise Tizen::Io doxygen

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

diff --git a/inc/FSecCryptoCastCipher.h b/inc/FSecCryptoCastCipher.h
index 977333b..4048ccb 100644 (file)
--- a/inc/FSecCryptoCastCipher.h
+++ b/inc/FSecCryptoCastCipher.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,8 +39,8 @@ class _SymmetricCipher;
  *     @since       2.0
  *
  *     The %CastCipher class provides a symmetric cipher using the CAST-128 algorithm.
- *     Set appropriate values for the requested mode/key bit/padding scheme and cipher operation mode (CIPHER_ENCRYPT
- *     or CIPHER_DECRYPT) parameters. @n
+ *     Set appropriate values for the requested mode/key bit/padding scheme and cipher operation mode (::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>.
  *
@@ -118,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
@@ -131,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);
 
@@ -140,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
@@ -153,8 +151,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* DecryptN(const Tizen::Base::ByteBuffer& input);
 
@@ -162,7 +159,7 @@ public:
         *      Initializes a multiple-part encryption or decryption operation.
         *
         *      @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.
@@ -170,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);