Add missing description for doxygen doc

[platform/core/api/connection.git] / include / connection_extension.h

diff --git a/include/connection_extension.h b/include/connection_extension.h
index bee17ca..667c969 100755 (executable)
--- a/include/connection_extension.h
+++ b/include/connection_extension.h
@@ -468,7 +468,7 @@ int connection_profile_set_ethernet_eap_client_cert_file(connection_profile_h pr
  * @brief Gets the Client Certificate of EAP.
  * @since_tizen 6.0
  * @remarks This function is valid only if the EAP type is #CONNECTION_ETHERNET_EAP_TYPE_TLS.
- *     You must release @a file using free().
+ *     You must release @a file using free().
  * @param[in] profile          The profile handle
  * @param[out] file             The file path of Client Certificate
  * @return 0 on success, otherwise negative error value
@@ -498,7 +498,7 @@ int connection_profile_set_ethernet_eap_pac_file(connection_profile_h profile, c
  * @brief Gets the PAC file of EAP.
  * @since_tizen 6.0
  * @remarks This function is valid only if the EAP type is #CONNECTION_ETHERNET_EAP_TYPE_FAST.
- *     You must release @a file using free().
+ *     You must release @a file using free().
  * @param[in] profile          The profile handle
  * @param[out] file             The path of PAC file
  * @return 0 on success, otherwise negative error value
@@ -558,7 +558,7 @@ int connection_profile_set_ethernet_eap_identity(connection_profile_h profile, c
  * @brief Gets the identity of EAP over ethernet.
  * @since_tizen 6.0
  * @remarks This function is valid only if the EAP type is #CONNECTION_ETHERNET_EAP_TYPE_TLS.
- *     You must release @a identity using free().
+ *     You must release @a identity using free().
  * @param[in] profile          The profile handle
  * @param[out] identity                The identity of ethernet.
  * @return 0 on success, otherwise negative error value
@@ -589,7 +589,7 @@ int connection_profile_set_ethernet_eap_private_key_info(connection_profile_h pr
  * @brief Gets the private key file of EAP.
  * @since_tizen 6.0
  * @remarks This function is valid only if the EAP type is #CONNECTION_ETHERNET_EAP_TYPE_TLS.
- *     You must release @a file using free().
+ *     You must release @a file using free().
  * @param[in] profile          The profile handle
  * @param[out] file             The file path of private key
  * @return 0 on success, otherwise negative error value
@@ -605,7 +605,7 @@ int connection_profile_get_ethernet_eap_private_key_file(connection_profile_h pr
  * @brief Sets the user name and passphrase of EAP.
  * @since_tizen 6.0
  * @remarks This function is valid only if the EAP type is #CONNECTION_ETHERNET_EAP_TYPE_MD5,
- *     #CONNECTION_ETHERNET_EAP_TYPE_PEAP, #CONNECTION_ETHERNET_EAP_TYPE_TTLS or #CONNECTION_ETHERNET_EAP_TYPE_FAST.
+ *     #CONNECTION_ETHERNET_EAP_TYPE_PEAP, #CONNECTION_ETHERNET_EAP_TYPE_TTLS or #CONNECTION_ETHERNET_EAP_TYPE_FAST.
  * @param[in] profile          The profile handle
  * @param[in] user_name         The user name
  * @param[in] password          The password
@@ -622,8 +622,8 @@ int connection_profile_set_ethernet_eap_passphrase(connection_profile_h profile,
  * @brief Gets the username and password status of EAP.
  * @since_tizen 6.0
  * @remarks This function is valid only if the EAP type is #CONNECTION_ETHERNET_EAP_TYPE_MD5,
- *     #CONNECTION_ETHERNET_EAP_TYPE_PEAP, #CONNECTION_ETHERNET_EAP_TYPE_TTLS or #CONNECTION_ETHERNET_EAP_TYPE_FAST.
- *     You must release @a user_name using free().
+ *     #CONNECTION_ETHERNET_EAP_TYPE_PEAP, #CONNECTION_ETHERNET_EAP_TYPE_TTLS or #CONNECTION_ETHERNET_EAP_TYPE_FAST.
+ *     You must release @a user_name using free().
  * @param[in] profile          The profile handle
  * @param[out] user_name        The user name
  * @param[out] is_password_set  @c true if password is set,
@@ -680,6 +680,62 @@ int connection_profile_save_ethernet_eap_config(connection_h connection,
                                                        connection_profile_h profile);
 
 /**
+ * @brief Check if the time has been updated by NTP.
+ * @since_tizen 6.5
+ * @param[in] connection       The connection handle
+ * @param[out] updated         true if the system time is updated by NTP, false otherwise
+ * @return 0 on success, otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE                 Successful
+ * @retval #CONNECTION_ERROR_INVALID_OPERATION    Invalid operation
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER    Invalid parameter
+ * @retval #CONNECTION_ERROR_PERMISSION_DENIED    Permission denied
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED        Not supported
+ */
+int connection_clock_is_updated(connection_h connection, bool *updated);
+
+/**
+ * @brief Sets NTP server.
+ * @since_tizen 8.0
+ * @param[in] connection       The connection handle
+ * @param[in] ntp_server       requested NTP server IP/URL
+ * @return 0 on success, otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE                 Successful
+ * @retval #CONNECTION_ERROR_INVALID_OPERATION    Invalid operation
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER    Invalid parameter
+ * @retval #CONNECTION_ERROR_PERMISSION_DENIED    Permission denied
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED        Not supported
+ */
+int connection_set_ntp_server(connection_h connection, const char *ntp_server);
+
+/**
+ * @brief Get NTP server url.
+ * @since_tizen 8.0
+ * @remarks You must release @a ntp_server using free().
+ * @param[in] connection       The connection handle
+ * @param[out] ntp_server       The IP/URL of NTP Server
+ * @return 0 on success, otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE                 Successful
+ * @retval #CONNECTION_ERROR_INVALID_OPERATION    Invalid operation
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER    Invalid parameter
+ * @retval #CONNECTION_ERROR_PERMISSION_DENIED    Permission denied
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED        Not supported
+ */
+int connection_get_ntp_server(connection_h connection, char **ntp_server);
+
+/**
+ * @brief Clear NTP server.
+ * @since_tizen 8.0
+ * @param[in] connection       The connection handle
+ * @return 0 on success, otherwise a negative error value
+ * @retval #CONNECTION_ERROR_NONE                 Successful
+ * @retval #CONNECTION_ERROR_INVALID_OPERATION    Invalid operation
+ * @retval #CONNECTION_ERROR_INVALID_PARAMETER    Invalid parameter
+ * @retval #CONNECTION_ERROR_PERMISSION_DENIED    Permission denied
+ * @retval #CONNECTION_ERROR_NOT_SUPPORTED        Not supported
+ */
+int connection_clear_ntp_server(connection_h connection);
+
+/**
 * @}
 */