Apply reviewed doxygen header
[platform/framework/native/appfw.git] / inc / FSecCryptoKeaKeyExchange.h
index 1a50489..e969c07 100644 (file)
@@ -33,17 +33,17 @@ namespace Tizen { namespace Security { namespace Crypto
  *     @class          KeaKeyExchange
  *     @brief          This class provides methods for performing the key exchange mechanism using Key Exchange Algorithm (KEA).
  *
 *    @since       2.0
*     @since          2.0
  *
  *     The %KeaKeyExchange class provides a KEA key exchange between two communicating users. @n
  *
 *    For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/security/key_exchange_algorithm.htm">Key exchanging</a>.
    For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/security/key_exchange_algorithm.htm">Key exchanging</a>.
  *
 *    @see    IKeyExchange
 *    @see    KeyPairGenerator
    @see    IKeyExchange
    @see    KeyPairGenerator
  *
 *    The following example demonstrates how to use the %KeaKeyExchange class.
 *    @code
    The following example demonstrates how to use the %KeaKeyExchange class.
    @code
  *
  *     void KeaGenerateSecretExample(void)
  *     {
@@ -292,7 +292,7 @@ public:
         *                                                                              This parameter needs to be instantiated.
         *      @exception      E_SUCCESS                               The method is successful.
         *      @exception      E_INVALID_ARG                   The specified input parameter is invalid.
-        *      @exception      E_OUT_OF_MEMORY The memory is insufficient.
+        *      @exception      E_OUT_OF_MEMORY                 The memory is insufficient.
         */
        virtual result Construct(const Tizen::Security::IKeyParameters& keyParameters);
 
@@ -308,9 +308,10 @@ public:
         *      @exception      E_SUCCESS                               The method is successful.
         *      @exception      E_INVALID_ARG                   A specified input parameter is invalid.
         *      @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* GenerateSecretN(Tizen::Security::IPrivateKey& privateKey, Tizen::Security::IPublicKey& publicKey);