//
-// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
*
* 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)
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
*/
/**
* 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.
*
* @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
*
* @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
*
* 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;
} } } //Tizen::Security::Crypto
-#endif //_FSEC_CRYPTO_IHASH_H_
+#endif //_FSEC_CRYPTO_IHASH_H_