X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;ds=sidebyside;f=inc%2FFSecCryptoIHash.h;h=90f0b58455f0f52a68dac5b5a558f9e644c94b00;hb=07a771d39ebf4c7f26a04aeb3e06f9d7eb1c6dc2;hp=1475b32220553cab9b97f8fcbf443b48c8e38a61;hpb=90fa7aa7bcf38cf05b7095750cf6d7f0b678e4fd;p=platform%2Fframework%2Fnative%2Fappfw.git

diff --git a/inc/FSecCryptoIHash.h b/inc/FSecCryptoIHash.h
index 1475b32..90f0b58 100644
--- a/inc/FSecCryptoIHash.h
+++ b/inc/FSecCryptoIHash.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 @@ namespace Tizen { namespace Security { namespace Crypto
  *
  *	For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/security/hashing.htm">Hashing</a>. @n
  *
- *  The following example demonstrates how to use the %IHash interface.
- *  @code
+ *	The following example demonstrates how to use the %IHash interface.
+ *	@code
  *
  *	result
  *	MyClass::TestHashSample(void)
@@ -196,8 +195,8 @@ class _OSP_EXPORT_ IHash
 
 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
 	 */
@@ -205,12 +204,12 @@ public:
 
 	/**
 	 *	Sets the hash algorithm. @n
-	 *	Only supported in Secure Hash Algorithm-2 (SHA-2).
+	 *	This method is only supported in Secure Hash Algorithm-2 (SHA-2).
 	 *
 	 *	@since		2.0
 	 *
 	 *	@return		An error code
-	 *	@param[in]	algorithm				The name of the hash algorithm @n
+	 *	@param[in]	algorithm				The hash algorithm name @n
 	 *										For example, "SHA2/224", "SHA2/256", "SHA2/384", or "SHA2/512".
 	 *	@exception	E_SUCCESS				The method is successful.
 	 *	@exception	E_UNSUPPORTED_ALGORITHM	The algorithm is not supported.
@@ -224,31 +223,33 @@ public:
 	 *
 	 *	@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
+	 *	@param[in]	input					An instance of Tizen::Base::ByteBuffer containing the data
 	 *	@exception	E_SUCCESS				The method is successful.
 	 *	@exception	E_INVALID_ARG			The input Tizen::Base::ByteBuffer is empty or contains invalid data.
 	 *	@exception	E_OUT_OF_MEMORY			The memory is insufficient.
-	 *	@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* GetHashN(const Tizen::Base::ByteBuffer& input) const = 0;
 
 	/**
-	 *	Initializes a multiple-part hash operation.
+	 *	Initializes the multiple-part hash operation.
 	 *
 	 *	@since		2.0
 	 *
 	 *	@return		An error code
 	 *	@exception	E_SUCCESS				The method is successful.
 	 *	@exception	E_OUT_OF_MEMORY			The memory is insufficient.
-	 *	@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 hash operation while processing another data part.
+	 *	Updates the multiple-part hash operation while processing another data part.
 	 *
 	 *	@since		2.0
 	 *
@@ -257,14 +258,15 @@ public:
 	 *	@exception	E_SUCCESS				The method is successful.
 	 *	@exception	E_INVALID_ARG			The input Tizen::Base::ByteBuffer is empty or contains invalid data.
 	 *	@exception	E_OUT_OF_MEMORY			The memory is insufficient.
-	 *	@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 result Update(const Tizen::Base::ByteBuffer& input) = 0;
 
 	/**
-	 *	Finalizes a multiple-part hash operation.
+	 *	Finalizes the multiple-part hash operation.
 	 *
 	 *	@since		2.0
 	 *
@@ -272,9 +274,10 @@ public:
 	 *				else @c null if an error occurs
 	 *	@exception	E_SUCCESS				The method is successful.
 	 *	@exception	E_OUT_OF_MEMORY			The memory is insufficient.
-	 *	@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* FinalizeN(void) = 0;
 
@@ -293,4 +296,4 @@ protected:
 
 } } } //Tizen::Security::Crypto
 
-#endif //_FSEC_CRYPTO_IHASH_H_        
+#endif //_FSEC_CRYPTO_IHASH_H_