X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFSecCryptoSha2Hash.h;h=12910fb89ebe592850685f82ad1ab09826f84066;hb=20597a73bc3098301ba91a48378f3ef009c3be96;hp=6075888898f403447e8e7253c478fa3bd95660b1;hpb=6b44196c40a66b895028f7ba2e9b5e41bc715ab2;p=platform%2Fframework%2Fnative%2Fappfw.git diff --git a/inc/FSecCryptoSha2Hash.h b/inc/FSecCryptoSha2Hash.h old mode 100644 new mode 100755 index 6075888..12910fb --- a/inc/FSecCryptoSha2Hash.h +++ b/inc/FSecCryptoSha2Hash.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 @@ namespace Tizen { namespace Security { namespace Crypto * * The %Sha2Hash class implements the SHA-2 hash algorithm. @n * - * For more information on the class features, see Hashing. + * For more information on the class features, see Hashing. * * @see Tizen::Security::Crypto::IHash * @see Tizen::Security::Crypto::Md5Hash @@ -60,7 +59,7 @@ public: Sha2Hash(void); /** - * This destructor overrides Tizen::Base::Object::~Object(). + * This destructor overrides Tizen::Base::Object::~Object(). * * @since 2.0 */ @@ -72,15 +71,15 @@ public: * @since 2.0 * * @return An error code - * @param[in] algorithm The name of the hash algorithm @n - * For example, "SHA2/224", "SHA2/256", "SHA2/386", or "SHA2/512". + * @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. */ virtual result SetAlgorithm(const Tizen::Base::String& algorithm); /** - * Gets the hashes of the data (single-part). + * Gets the hashes of the specified data (single-part). * * @since 2.0 * @@ -90,9 +89,10 @@ 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. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* GetHashN(const Tizen::Base::ByteBuffer& input) const; @@ -105,13 +105,14 @@ public: * @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); /** - * 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 * @@ -120,14 +121,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); /** - * Finalizes a multiple-part hash operation. + * Finalizes the multiple-part hash operation. * * @since 2.0 * @@ -135,9 +137,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. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* FinalizeN(void);