//
-// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
//
/**
- * @file FSecCryptoDhKeyExchange.h
+ * @file FSecCryptoDhKeyExchange.h
* @brief This is the header file for the %DhKeyExchange class.
*
* This header file contains the declarations of the %DhKeyExchange class.
* @class DhKeyExchange
* @brief This class provides methods for a key exchange mechanism using the Diffie-Hellman (DH) algorithm.
*
- * @since 2.0
+ * @since 2.0
*
* The %DhKeyExchange class provides a DH key exchange between two communicating users. @n
*
* @since 2.0
*
* @return An error code
- * @param[in] keyParameters The domain parameters ('p' prime number and 'g' generator) of DH
- * algorithm that needs to instantiate
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_INVALID_ARG The specified input parameter is invalid, or the specified @c keyParameters does not contain a valid value. */
+ * @param[in] keyParameters The domain parameters ('p' prime number and 'g' generator) of DH algorithm
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_INVALID_ARG The specified input parameter is invalid, or the specified @c keyParameters does not contain a valid value.
+ */
virtual result Construct(const Tizen::Security::IKeyParameters& keyParameters);
/**
* @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.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @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);