Update comments as per guideline

Change-Id: I75c05778611ca8c652bbb78157c456f8f6e53825
Signed-off-by: Jaehyun Kim <jeik01.kim@samsung.com>

diff --git a/include/wifi-manager.h b/include/wifi-manager.h
index 2560b41..245aa72 100755 (executable)
--- a/include/wifi-manager.h
+++ b/include/wifi-manager.h
@@ -780,7 +780,7 @@ typedef void *wifi_manager_ap_h;
 */
 
 /**
- * @brief The Wi-Fi access point configuration handle
+ * @brief The Wi-Fi access point configuration handle.
  * @since_tizen 3.0
  */
 typedef void *wifi_manager_config_h;
@@ -832,7 +832,7 @@ typedef enum {
 /**
  * @brief Called for each found access point.
  * @since_tizen 3.0
- * @remarks @a AP is valid only in this function. In order to use @a AP outside this function, you must copy the AP with wifi_manager_ap_clone().
+ * @remarks @a ap is valid only in this function. In order to use @a AP outside this function, you must copy the AP with wifi_manager_ap_clone().
  * @param[in]  ap           The access point
  * @param[in]  user_data    The user data passed from the request function
  * @return  @c true to continue with the next iteration of the loop, \n
@@ -857,6 +857,9 @@ typedef void(*wifi_manager_scan_finished_cb)(wifi_manager_error_e error_code, vo
 
 /**
  * @brief Called when the scanning state is changed.
+ * @details The following error codes can be received: \n
+ *              #WIFI_MANAGER_ERROR_NONE                 Successful \n
+ *              #WIFI_MANAGER_ERROR_OPERATION_FAILED     Operation failed
  * @since_tizen 4.0
  * @param[in] state         The wifi scanning state
  * @param[in] user_data     The user data passed from the callback registration function
@@ -867,6 +870,10 @@ typedef void(*wifi_manager_scan_state_changed_cb)(wifi_manager_scan_state_e stat
 
 /**
  * @brief Called after wifi_manager_activate() or wifi_manager_activate_with_wifi_picker_tested() is completed.
+ * @details The following error codes can be received: \n
+ *              #WIFI_MANAGER_ERROR_NONE                 Successful \n
+ *              #WIFI_MANAGER_ERROR_OPERATION_FAILED     Operation failed \n
+ *              #WIFI_MANAGER_ERROR_SECURITY_RESTRICTED  Restricted by security system policy
  * @since_tizen 3.0
  * @param[in] result        The result
  * @param[in] user_data     The user data passed from wifi_manager_activate() and wifi_manager_activate_with_wifi_picker_tested()
@@ -878,6 +885,10 @@ typedef void(*wifi_manager_activated_cb)(wifi_manager_error_e result, void *user
 
 /**
  * @brief Called after wifi_manager_deactivate() is completed.
+ * @details The following error codes can be received: \n
+ *              #WIFI_MANAGER_ERROR_NONE                 Successful \n
+ *              #WIFI_MANAGER_ERROR_OPERATION_FAILED     Operation failed \n
+ *              #WIFI_MANAGER_ERROR_SECURITY_RESTRICTED  Restricted by security system policy
  * @since_tizen 3.0
  * @param[in] result        The result
  * @param[in] user_data     The user data passed from wifi_manager_deactivate()
@@ -895,7 +906,22 @@ typedef void(*wifi_manager_deactivated_cb)(wifi_manager_error_e result, void *us
  *     - wifi_manager_connect_by_wps_pin()
  *     - wifi_manager_connect_by_wps_pbc_without_ssid()
  *     - wifi_manager_connect_by_wps_pin_without_ssid()
- *     - wifi_manager_connect_hidden_ap()
+ *     - wifi_manager_connect_hidden_ap() \n\n
+ * The following error codes can be received: \n
+ *              #WIFI_MANAGER_ERROR_NONE                     Successful \n
+ *              #WIFI_MANAGER_ERROR_OPERATION_FAILED         Operation failed \n
+ *              #WIFI_MANAGER_ERROR_OPERATION_ABORTED        Operation aborted \n
+ *              #WIFI_MANAGER_ERROR_ALREADY_EXISTS           Connection already exists \n
+ *              #WIFI_MANAGER_ERROR_OUT_OF_RANGE             Out of range \n
+ *              #WIFI_MANAGER_ERROR_DHCP_FAILED              DHCP failed \n
+ *              #WIFI_MANAGER_ERROR_CONNECT_FAILED           Connect failed \n
+ *              #WIFI_MANAGER_ERROR_LOGIN_FAILED             Login failed \n
+ *              #WIFI_MANAGER_ERROR_AUTHENTICATION_FAILED    Authentication failed \n
+ *              #WIFI_MANAGER_ERROR_INVALID_KEY              Invalid key \n
+ *              #WIFI_MANAGER_ERROR_PIN_MISSING              PIN missing \n
+ *              #WIFI_MANAGER_ERROR_WPS_OVERLAP              WPS Overlap \n
+ *              #WIFI_MANAGER_ERROR_WPS_TIMEOUT              WPS Timeout \n
+ *              #WIFI_MANAGER_ERROR_WPS_WEP_PROHIBITED       WPS WEP Prohibited
  * @since_tizen 3.0
  * @param[in] result        The result
  * @param[in] user_data     The user data passed from the connection function.
@@ -911,6 +937,9 @@ typedef void(*wifi_manager_connected_cb)(wifi_manager_error_e result, void *user
 
 /**
  * @brief Called after wifi_manager_disconnect() is completed.
+ * @details The following error codes can be received: \n
+ *              #WIFI_MANAGER_ERROR_NONE                 Successful \n
+ *              #WIFI_MANAGER_ERROR_OPERATION_FAILED     Operation failed
  * @since_tizen 3.0
  * @param[in] result        The result
  * @param[in] user_data     The user data passed from wifi_manager_disconnect()
@@ -934,6 +963,9 @@ typedef void(*wifi_manager_forget_ap_finished_cb)(wifi_manager_error_e result, v
 
 /**
  * @brief Called when the BSSID scan is finished.
+ * @details The following error codes can be received: \n
+ *              #WIFI_MANAGER_ERROR_NONE                 Successful \n
+ *              #WIFI_MANAGER_ERROR_OPERATION_FAILED     Operation failed
  * @since_tizen 4.0
  * @param[in] error_code    The error code
  * @param[in] user_data     The user data passed from the callback registration function
@@ -1056,6 +1088,7 @@ typedef void(*wifi_manager_tdls_state_changed_cb)(wifi_manager_tdls_state_e stat
 
 /**
  * @brief Called when the Wi-Fi TDLS is discovered.
+ * @since_tizen 4.0
  * @remarks @a peer_mac_addr is usable only in the callback. To use outside the callback, make a copy.
  * @param[in] state          The TDLS state
  * @param[in] peer_mac_addr  The MAC address of the TDLS peer