Revise Tizen::Io doxygen

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

diff --git a/inc/FSecCryptoSkipJackCipher.h b/inc/FSecCryptoSkipJackCipher.h
index e0a6c80..8c1f67b 100755 (executable)
--- a/inc/FSecCryptoSkipJackCipher.h
+++ b/inc/FSecCryptoSkipJackCipher.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,7 +39,7 @@ class _SymmetricCipher;
  * @since   2.0
  *
  * The %SkipJackCipher class provides a symmetric cipher using the Skipjack algorithm. Appropriate values have to be set for the requested mode or key bit or
- * padding scheme and the cipher operation (CIPHER_ENCRYPT or CIPHER_DECRYPT) parameters. @n
+ * padding scheme and the cipher operation (::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>.
  *
@@ -119,7 +118,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
@@ -132,8 +131,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);
 
@@ -141,7 +139,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
@@ -154,8 +152,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);
 
@@ -163,7 +160,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.
@@ -171,7 +168,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);
 
@@ -219,8 +215,9 @@ 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 %SkipJackCipher. 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 %SkipJackCipher. 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);
 
@@ -232,8 +229,9 @@ 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 %SkipJackCipher. Therefore, this method always returns @c null. @n
-        * @remarks             The @c E_UNSUPPORTED_ALGORITHM exception is returned using the GetLastResult() method.
+        * @remarks             
+        *                      - This operation is not supported in %SkipJackCipher. Therefore, this method always returns @c null. @n
+        *                      - The @c E_UNSUPPORTED_ALGORITHM exception is returned using the GetLastResult() method.
         */
        virtual Tizen::Base::ByteBuffer* UnwrapN(const Tizen::Base::ByteBuffer& wrappedKey);