X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFSecCryptoISymmetricCipher.h;h=7f344dcda04dce38049b722de1ba75dd7a9027f8;hb=b54953ec1a6df32b1f10ce54ec189c9a3ad826b0;hp=d6108e44e231f2666cd3afe43f9c89054229393d;hpb=52af7a7653f5c58c84cf9cc16bf92ae25e037462;p=platform%2Fframework%2Fnative%2Fappfw.git

diff --git a/inc/FSecCryptoISymmetricCipher.h b/inc/FSecCryptoISymmetricCipher.h
index d6108e4..7f344dc 100644
--- a/inc/FSecCryptoISymmetricCipher.h
+++ b/inc/FSecCryptoISymmetricCipher.h
@@ -15,7 +15,7 @@
 //
 
 /**
- *	@file		FSecCryptoISymmetricCipher.h
+ *	@file	FSecCryptoISymmetricCipher.h
  *	@brief	This is the header file for the %ISymmetricCipher interface.
  *
  *	This header file contains the declarations of the %ISymmetricCipher interface.
@@ -223,8 +223,8 @@ class _OSP_EXPORT_ ISymmetricCipher
 
 public:
 	/**
-	 * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n
-	 * are called when the destructor of this interface is called.
+	 * This polymorphic destructor should be overridden if required. @n 
+	 * This way, the destructors of the derived classes are called when the destructor of this interface is called.
 	 *
 	 *	@since		2.0
 	 */
@@ -236,7 +236,7 @@ public:
 	 *	@since		2.0
 	 *
 	 *	@return		An error code
-	 *	@param[in]	transformation			The name of the requested mode or key bit or padding scheme
+	 *	@param[in]	transformation			The requested mode or key bit or padding scheme
 	 *	@param[in]	opMode					The cipher operation mode @n
 	 *										For example, @c CIPHER_ENCRYPT, @c CIPHER_DECRYPT, @c CIPHER_WRAP, or @c CIPHER_UNWRAP.
 	 *	@exception	E_SUCCESS				The method is successful.
@@ -247,12 +247,12 @@ public:
 	virtual result Construct(const Tizen::Base::String& transformation, enum CipherOperation opMode = Tizen::Security::Crypto::CIPHER_ENCRYPT) = 0;
 
 	/**
-	 *	Sets a symmetric key for encryption or decryption.
+	 *	Sets the symmetric key for encryption or decryption.
 	 *
 	 *	@since		2.0
 	 *
 	 *	@return		An error code
-	 *	@param[in]	key						An instance of ISecretKey
+	 *	@param[in]	key						An instance of ISecretKey to set
 	 *	@exception	E_SUCCESS				The method is successful.
 	 *	@exception	E_INVALID_ARG			The specified @c key is invalid.
 	 *	@exception	E_OUT_OF_MEMORY			The memory is insufficient.
@@ -265,7 +265,7 @@ public:
 	 *	@since		2.0
 	 *
 	 *	@return		An error code
-	 *	@param[in]	initialVector			The initial vector
+	 *	@param[in]	initialVector			The initial vector to set
 	 *	@exception	E_SUCCESS				The method is successful.
 	 *	@exception	E_INVALID_ARG			The specified input parameter is invalid.
 	 *	@exception	E_OUT_OF_MEMORY			The memory is insufficient.
@@ -286,9 +286,10 @@ public:
 	 *	@exception	E_KEY_NOT_FOUND			The key is not found.
 	 *	@exception	E_INVALID_OPERATION		The specified cipher operation mode for this method is invalid.
 	 *	@exception	E_OVERFLOW				This operation has caused the memory to overflow.
-	 *	@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* EncryptN(const Tizen::Base::ByteBuffer& input) = 0;
 
@@ -306,14 +307,16 @@ public:
 	 *	@exception	E_KEY_NOT_FOUND			The key is not found.
 	 *	@exception	E_INVALID_OPERATION		The specified cipher operation mode for this method is invalid.
 	 *	@exception	E_OVERFLOW				This operation has caused the memory to overflow.
-	 *	@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;
 
 	/**
-	 *	Initializes a multiple-part encryption or decryption operation.
+	 * Initializes the instance of %ISymmetricCipher for the multiple-part encryption or decryption operation.
+	 *
 	 *
 	 *	@since		2.0
 	 *
@@ -322,13 +325,14 @@ public:
 	 *	@exception	E_OUT_OF_MEMORY			The memory is insufficient.
 	 *	@exception	E_KEY_NOT_FOUND			The 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.
+	 *	@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.
 	 */
 	virtual result Initialize(void) = 0;
 
 	/**
-	 *	Updates a multiple-part encryption or decryption operation.
+	 *	Updates the instance of %ISymmetricCipher for the multiple-part encryption or decryption operation.
 	 *
 	 *	@since		2.0
 	 *
@@ -339,15 +343,16 @@ public:
 	 *	@exception	E_OUT_OF_MEMORY			The memory is insufficient.
 	 *	@exception	E_OVERFLOW				This operation has caused the memory to overflow.
 	 *	@exception	E_INVALID_ARG			The input Tizen::Base::ByteBuffer is empty or contains invalid data.
-	 *	@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.
+	 *	@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.
+	 *	@remarks	The specific error code can be accessed using the GetLastResult() method.
 	 */
 	virtual Tizen::Base::ByteBuffer* UpdateN(const Tizen::Base::ByteBuffer& input) = 0;
 
 	/**
-	 *	Finalizes a multiple-part encryption or decryption operation.
+	 *	Finalizes the instance of %ISymmetricCipher for the multiple-part encryption or decryption operation.
 	 *
 	 *	@since		2.0
 	 *
@@ -356,15 +361,16 @@ public:
 	 *	@exception	E_SUCCESS				The method is successful.
 	 *	@exception	E_OUT_OF_MEMORY			The memory is insufficient.
 	 *	@exception	E_OVERFLOW				This operation has caused the memory to overflow.
-	 *	@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.
 	 *	@remarks		The specific error code can be accessed using the GetLastResult() method.
 	 */
 	virtual Tizen::Base::ByteBuffer* FinalizeN(void) = 0;
 
 	/**
-	 *	Wraps the specified key.
+	 *	Wraps a key.
 	 *
 	 *	@since		2.0
 	 *
@@ -376,11 +382,12 @@ public:
 	 *	@exception	E_OUT_OF_MEMORY			The memory is insufficient.
 	 *	@exception	E_KEY_NOT_FOUND			The 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, or
-	 *										the Tizen::Base::ByteBuffer operation has failed.
- 	 *	@remarks		
- 	 *			- The specific error code can be accessed using the GetLastResult() method.
+	 *	@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.
+	 *	@remarks		
+	 *			- The specific error code can be accessed using the GetLastResult() method.
 	 *			- This operation is only supported in AesCipher.
 	 */
 	virtual Tizen::Base::ByteBuffer* WrapN(const Tizen::Base::ByteBuffer& secretKey) = 0;
@@ -398,9 +405,10 @@ public:
 	 *	@exception	E_OUT_OF_MEMORY			The memory is insufficient.
 	 *	@exception	E_KEY_NOT_FOUND			The 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, 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.	 
 	 *	@remarks		
 	 *			- The specific error code can be accessed using the GetLastResult() method.
 	 *			- This operation is only supported in AesCipher.