X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFSecCryptoIAsymmetricCipher.h;h=855ed6957b7c72ad32564bc39f07c83e2e0a60b0;hb=07a771d39ebf4c7f26a04aeb3e06f9d7eb1c6dc2;hp=d540f92124d6641dbd0052a5868f1ddffba691a3;hpb=6b44196c40a66b895028f7ba2e9b5e41bc715ab2;p=platform%2Fframework%2Fnative%2Fappfw.git diff --git a/inc/FSecCryptoIAsymmetricCipher.h b/inc/FSecCryptoIAsymmetricCipher.h index d540f92..855ed69 100644 --- a/inc/FSecCryptoIAsymmetricCipher.h +++ b/inc/FSecCryptoIAsymmetricCipher.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); @@ -37,7 +36,7 @@ namespace Tizen { namespace Security { namespace Crypto /** * @interface IAsymmetricCipher - * @brief This interface provides the functionality of an asymmetric cryptographic cipher for encryption and decryption. + * @brief This interface provides methods for the functionality of an asymmetric cryptographic cipher for encryption and decryption. * * @since 2.0 * @@ -164,7 +163,7 @@ public: virtual ~IAsymmetricCipher(void) {} /** - * Sets an asymmetric private key for encryption or decryption. + * Sets the asymmetric private key for encryption or decryption. * * @since 2.0 * @@ -177,7 +176,7 @@ public: virtual result SetPrivateKey(const Tizen::Security::IKey& key) = 0; /** - * Sets an asymmetric public key for encryption or decryption. + * Sets the asymmetric public key for encryption or decryption. * * @since 2.0 * @@ -194,7 +193,7 @@ public: * * @since 2.0 * - * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n + * @return A pointer to the Tizen::Base::ByteBuffer instance that contains the output, @n * else @c null if an error occurs * @param[in] input An instance of Tizen::Base::ByteBuffer * @exception E_SUCCESS The method is successful. @@ -202,9 +201,10 @@ public: * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_UNSUPPORTED_ALGORITHM The algorithm is not supported. * @exception E_KEY_NOT_FOUND The specified key is not found. - * @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.n + * - 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; @@ -213,7 +213,7 @@ public: * * @since 2.0 * - * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n + * @return A pointer to the Tizen::Base::ByteBuffer instance that contains the output, @n * else @c null if an error occurs * @param[in] input An instance of Tizen::Base::ByteBuffer * @exception E_SUCCESS The method is successful. @@ -221,9 +221,10 @@ public: * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_UNSUPPORTED_ALGORITHM The algorithm is not supported. * @exception E_KEY_NOT_FOUND The specified key is not found. - * @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;