Fixed memory leak in RsaConvertKey function.
[platform/framework/native/appfw.git] / inc / FSecSecretKeyGenerator.h
index 9671a65..ac91aac 100755 (executable)
@@ -33,11 +33,12 @@ namespace Tizen { namespace Security
 
 /**
  *     @class          SecretKeyGenerator
- *     @brief          This class is used for generating a secret (symmetric) key.
+ *     @brief          This class provides methods for generating a secret (symmetric) key.
  *
- *     @since       2.0
+ *     @since          2.0
  *
- *  The %SecretKeyGenerator class generates a secret key, which is used in symmetric ciphers. The generated secret key is based on an encryption algorithm. @n
+ *  The %SecretKeyGenerator class generates a secret key, which is used in symmetric ciphers. The generated secret key 
+ *  is based on an encryption algorithm. @n
  *
  *     For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/security/key_mgmt_and_csprng.htm">Key Management and CSPRNG</a>.
  *
@@ -50,24 +51,24 @@ class _OSP_EXPORT_ SecretKeyGenerator
 
 public:
        /**
-        * The object is not fully constructed after this constructor is called. For full construction, @n
-        * the Construct() method must be called right after calling this constructor.
+        *      The object is not fully constructed after this constructor is called. For full construction, @n
+        *      the Construct() method must be called right after calling this constructor.
         *
-        * @since       2.0
+        *      @since          2.0
         */
        SecretKeyGenerator(void);
 
        /**
-        * This destructor overrides Tizen::Base::Object::~Object().
+        *      This destructor overrides Tizen::Base::Object::~Object().
         *
-        * @since       2.0
+        *      @since          2.0
         */
        virtual ~SecretKeyGenerator(void);
 
        /**
         *      Constructs and initializes this instance of %SecretKeyGenerator with the specified key.
         *
-        *      @since           2.0
+        *      @since          2.0
         *
         *      @return         An error code
         *      @param[in]      keyBytes                                The key of type Tizen::Base::ByteBuffer
@@ -80,11 +81,11 @@ public:
        /**
         *      Constructs and initializes this instance of %SecretKeyGenerator for the specified @c algorithm.
         *
-        *      @since           2.0
+        *      @since          2.0
         *
         *      @return         An error code
         *      @param[in]      algorithm                               The name of the secure random generator algorithm @n
-        *                                                                                      For example, "AES","DES", or "3DES".
+        *                                                                              For example, "AES","DES", or "3DES".
         *      @exception      E_SUCCESS                               The method is successful.
         *      @exception      E_INVALID_ARG                   The specified @c algorithm is invalid or an empty string.
         *      @exception      E_OUT_OF_MEMORY                 The memory is insufficient.
@@ -95,7 +96,7 @@ public:
         *      Constructs and initializes this instance of %SecretKeyGenerator with the specified key size. @n
         *      The default algorithm is Advanced Encryption Standard (AES).
         *
-        *      @since           2.0
+        *      @since          2.0
         *
         *      @return         An error code
         *      @param[in]      keySize                                 The key size
@@ -108,13 +109,13 @@ public:
        /**
         *      Generates a new secret key.
         *
-        *      @since           2.0
+        *      @since          2.0
         *
         *      @return         A pointer to the ISecretKey interface, @n
-        *                                      else @c null if it fails to generate a secret key
+        *                              else @c null if it fails to generate a secret key
         *      @exception      E_SUCCESS                               The method is successful.
         *      @exception      E_OUT_OF_MEMORY                 The memory is insufficient.
-        *      @exception      E_SYSTEM                A system error has occurred.
+        *      @exception      E_SYSTEM                                A system error has occurred.
         *      @remarks        The specific error code can be accessed using the GetLastResult() method.
         */
        virtual Tizen::Security::ISecretKey* GenerateKeyN(void);