Apply reviewed doxygen header
[platform/framework/native/appfw.git] / inc / FSecPrivateKey.h
index 0cc1ef0..425f17b 100644 (file)
@@ -15,7 +15,7 @@
 //
 
 /**
- * @file                       FSecPrivateKey.h
+ * @file               FSecPrivateKey.h
  * @brief              This is the header file for the %PrivateKey class.
  *
  * This header file contains the declarations of the %PrivateKey class.
@@ -32,13 +32,13 @@ namespace Tizen { namespace Security
 
 /**
  *     @class          PrivateKey
- *     @brief          This class specifies the RSA private key.
+ *     @brief          This class provides methods to manage the RSA private key.
  *
- *  @since      2.0
+ *     @since          2.0
  *
- *  The %PrivateKey class manages a private key, which is used in asymmetric ciphers. The RSA algorithm decrypts the data using the private key. @n
+ *     The %PrivateKey class manages a private key, which is used in asymmetric ciphers. The RSA algorithm decrypts the data using the private key. @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>.
+ *     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>.
  *
  *     @see    IKey
  *     @see    IPrivateKey
@@ -54,43 +54,43 @@ public:
        /**
         *      This is the default constructor for this class.
         *
-        * @since       2.0
+        *      @since          2.0
         */
        PrivateKey(void);
 
        /**
-        * This destructor overrides Tizen::Base::Object::~Object().
+        *      This destructor overrides Tizen::Base::Object::~Object().
         *
-        * @since       2.0
+        *      @since          2.0
         */
        virtual ~PrivateKey(void);
 
        /**
         *      Gets the name of the primary encoding format of the current instance of %PrivateKey.
         *
-        * @since       2.0
+        *      @since          2.0
         *
-        *      @return         The primary encoding format of a key
+        *      @return         The primary encoding format of the key
         */
        virtual Tizen::Base::String GetFormat(void) const;
 
        /**
         *      Gets the private key in its primary encoding format.
         *
-        *      @since           2.0
+        *      @since          2.0
         *
         *      @return         A pointer to the Tizen::Base::ByteBuffer class, @n
-        *                                      else @c null if an error occurs
+        *                              else @c null if an error occurs
         *      @exception      E_SUCCESS                               The method is successful.
         *      @exception      E_OUT_OF_MEMORY                 The memory is insufficient.
-        *  @remarks    The specific error code can be accessed using the GetLastResult() method.
+        *      @remarks        The specific error code can be accessed using the GetLastResult() method.
         */
        virtual Tizen::Base::ByteBuffer* GetEncodedN(void) const;
 
        /**
         *      Sets the private key buffer.
         *
-        * @since           2.0
+        *      @since          2.0
         *
         *      @return         An error code
         *      @param[in]      keyBuffer                               An instance of Tizen::Base::ByteBuffer