Enable build with iniparser v 3.1

[platform/framework/native/appfw.git] / inc / FSecCryptoISignature.h

diff --git a/inc/FSecCryptoISignature.h b/inc/FSecCryptoISignature.h
index 10a7cbd..a376b85 100755 (executable)
--- a/inc/FSecCryptoISignature.h
+++ b/inc/FSecCryptoISignature.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);
@@ -16,7 +15,7 @@
 //
 
 /**
- * @file                       FSecCryptoISignature.h
+ * @file               FSecCryptoISignature.h
  * @brief              This is the header file for the %ISignature interface.
  *
  * This header file contains the declarations of the %ISignature interface.
@@ -33,7 +32,7 @@ namespace Tizen { namespace Security { namespace Crypto
 
 /**
  *     @interface      ISignature
- *     @brief          This interface provides the functionality of a digital signature algorithm.
+ *     @brief          This interface provides methods for a digital signature algorithm.
  *
  *     @since          2.0
  *
@@ -43,7 +42,7 @@ namespace Tizen { namespace Security { namespace Crypto
  *
  *     The following example demonstrates how to use the %ISignature interface.
  *
- *  @code
+ *     @code
  *
  *     void
  *     MyClass::TestSignatureSample(void)
@@ -131,14 +130,14 @@ namespace Tizen { namespace Security { namespace Crypto
  *
  *             r       = E_SUCCESS;
  *
- *  CATCH:
+ *     CATCH:
  *             delete pSignature;
  *             delete pOutput;
  *             delete pKeyPairGen;
  *             delete pKeyPair;
- *   }
+ *     }
  *
- *  @endcode
+ *     @endcode
  */
 
 class _OSP_EXPORT_ ISignature
@@ -146,15 +145,15 @@ class _OSP_EXPORT_ ISignature
 
 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
         */
        virtual ~ISignature(void) {}
 
        /**
-        *      Sets an asymmetric private key for signature.
+        *      Sets the asymmetric private key for signature.
         *
         *      @since          2.0
         *
@@ -167,7 +166,7 @@ public:
        virtual result SetPrivateKey(const Tizen::Security::IKey& key) = 0;
 
        /**
-        *      Sets an asymmetric public key for verification.
+        *      Sets the asymmetric public key for verification.
         *
         *      @since          2.0
         *
@@ -191,14 +190,15 @@ public:
         *      @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_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* SignN(const Tizen::Base::ByteBuffer& input) = 0;
 
        /**
-        *      Verifies the data. @n
+        *      Verifies the specified data. @n
         *      The verification is done by comparing the @c signedData to the signature created by the @c data.
         *
         *      @since          2.0
@@ -211,9 +211,10 @@ public:
         *      @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_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 bool Verify(const Tizen::Base::ByteBuffer& data, const Tizen::Base::ByteBuffer& signedData) = 0;