X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFSecCryptoRc4Cipher.h;h=d2bd3e1630637f3be4b301bd62823e30bfa313e2;hb=9b44315473e675bcd332e2f56fac1ce00f87a8a6;hp=ac30c8ecd6fe99e0038dc2e88d4788ff9f2e7eb6;hpb=27f1388665067f69d5eb64e0cae6bb5f4250beec;p=platform%2Fframework%2Fnative%2Fappfw.git

diff --git a/inc/FSecCryptoRc4Cipher.h b/inc/FSecCryptoRc4Cipher.h
index ac30c8e..d2bd3e1 100644
--- a/inc/FSecCryptoRc4Cipher.h
+++ b/inc/FSecCryptoRc4Cipher.h
@@ -116,7 +116,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
@@ -129,8 +129,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);
 
@@ -138,7 +137,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
@@ -151,8 +150,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);
 
@@ -160,15 +158,14 @@ 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.
 	 *	@exception	E_KEY_NOT_FOUND				The specified key is not found.
 	 *	@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.
+						The method has failed to operate with the OpenSSL library.
 	 */
 	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 %Rc4Cipher class.
-	 *				Therefore, this method always returns @c null.
-	 *  @remarks	The @c E_UNSUPPORTED_ALGORITHM is returned using the GetLastResult() method.
+	 *	@remarks	
+	 *			- This operation is not supported in the %Rc4Cipher class.
+	 *			Therefore, this method always returns @c null.
+	 *			- The @c E_UNSUPPORTED_ALGORITHM 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 %Rc4Cipher class.
-	 *				Therefore, this method always returns @c null.
-	 *	@remarks	The @c E_UNSUPPORTED_ALGORITHM is returned using the GetLastResult() method.
+	 *	@remarks	
+	 *			- This operation is not supported in the %Rc4Cipher class.
+	 *			Therefore, this method always returns @c null.
+	 *			- The @c E_UNSUPPORTED_ALGORITHM is returned using the GetLastResult() method.
 	 */
 	virtual Tizen::Base::ByteBuffer* UnwrapN(const Tizen::Base::ByteBuffer& wrappedKey);