Modified description to avoid confusing 73/135773/2 accepted/tizen/unified/20170706.194144 accepted/tizen/unified/20170707.154544 submit/tizen/20170706.101920 submit/tizen/20170706.230808
authorSeonah Moon <seonah1.moon@samsung.com>
Mon, 26 Jun 2017 09:50:50 +0000 (18:50 +0900)
committertaesub kim <taesub.kim@samsung.com>
Mon, 3 Jul 2017 02:18:37 +0000 (02:18 +0000)
Using "API" when describing a single function is confusing.
A single function in an API is a "function".

Change-Id: Ic632668d73bf4ddd0914154a32d122a183aa1f8e
Signed-off-by: Seonah Moon <seonah1.moon@samsung.com>
include/wifi-manager.h

index e2f7fec..940bdc0 100755 (executable)
@@ -917,7 +917,7 @@ int wifi_manager_deinitialize(wifi_manager_h wifi);
  * @privlevel public
  * @privilege %http://tizen.org/privilege/network.set \n
  *            %http://tizen.org/privilege/network.get
- * @remark This API needs both privileges.
+ * @remark This function needs both privileges.
  * @param[in] wifi          The Wi-Fi handle
  * @param[in] callback      The callback function to be called \n
  *            This can be @c NULL if you don't want to get the notification.
@@ -942,7 +942,7 @@ int wifi_manager_activate(wifi_manager_h wifi, wifi_manager_activated_cb callbac
  * @privlevel public
  * @privilege %http://tizen.org/privilege/network.set \n
  *            %http://tizen.org/privilege/network.get
- * @remark This API needs both privileges.
+ * @remark This function needs both privileges.
  * @param[in] wifi          The Wi-Fi handle
  * @param[in] callback      The callback function to be called \n
  *            This can be @c NULL if you don't want to get the notification.
@@ -968,7 +968,7 @@ int wifi_manager_activate_with_wifi_picker_tested(wifi_manager_h wifi,
  * @privlevel public
  * @privilege %http://tizen.org/privilege/network.set \n
  *            %http://tizen.org/privilege/network.get
- * @remark This API needs both privileges.
+ * @remark This function needs both privileges.
  * @param[in] wifi          The Wi-Fi handle
  * @param[in] callback      The callback function to be called \n
  *            This can be @c NULL if you don't want to get the notification.
@@ -1041,7 +1041,7 @@ int wifi_manager_get_network_interface_name(wifi_manager_h wifi, char **name);
  * @privlevel public
  * @privilege %http://tizen.org/privilege/network.set \n
  *            %http://tizen.org/privilege/network.get
- * @remark This API needs both privileges.
+ * @remark This function needs both privileges.
  * @param[in] wifi            The Wi-Fi handle
  * @param[in] callback        The callback function to be called
  * @param[in] user_data       The user data passed to the callback function
@@ -1075,7 +1075,7 @@ int wifi_manager_get_scan_state(wifi_manager_h wifi, wifi_manager_scan_state_e *
  * @privlevel public
  * @privilege %http://tizen.org/privilege/network.set \n
  *            %http://tizen.org/privilege/network.get
- * @remark This API needs both privileges.
+ * @remark This function needs both privileges.
  * @param[in] wifi            The Wi-Fi handle
  * @param[in] essid           The essid of specific AP
  * @param[in] callback        The callback function to be called
@@ -1099,7 +1099,7 @@ int wifi_manager_scan_specific_ap(wifi_manager_h wifi,
  * @privilege %http://tizen.org/privilege/network.set \n
  *            %http://tizen.org/privilege/network.get \n
  *            %http://tizen.org/privilege/network.profile
- * @remark This API needs all listed privileges.
+ * @remark This function needs all listed privileges.
  * @param[in] wifi            The Wi-Fi handle
  * @param[in] essid           The ESSID of the hidden AP
  * @param[in] sec_type        The security type of the hidden AP
@@ -1113,7 +1113,7 @@ int wifi_manager_scan_specific_ap(wifi_manager_h wifi,
  * @retval #WIFI_MANAGER_ERROR_OPERATION_FAILED     Operation failed
  * @retval #WIFI_MANAGER_ERROR_PERMISSION_DENIED    Permission Denied
  * @retval #WIFI_MANAGER_ERROR_NOT_SUPPORTED        Not supported
- * @pre This API needs wifi_manager_scan() before use.
+ * @pre This function needs wifi_manager_scan() before use.
  * @post This function invokes wifi_manager_connected_cb().
  */
 int wifi_manager_connect_hidden_ap(wifi_manager_h wifi,
@@ -1204,7 +1204,7 @@ int wifi_manager_foreach_found_bssid_ap(wifi_manager_h wifi,
  * @privlevel public
  * @privilege %http://tizen.org/privilege/network.set \n
  *            %http://tizen.org/privilege/network.get
- * @remark This API needs both privileges.
+ * @remark This function needs both privileges.
  * @param[in] wifi            The Wi-Fi handle
  * @param[in] ap              The access point handle
  * @param[in] callback        The callback function to be called \n
@@ -1231,7 +1231,7 @@ int wifi_manager_connect(wifi_manager_h wifi, wifi_manager_ap_h ap, wifi_manager
  * @privlevel public
  * @privilege %http://tizen.org/privilege/network.set \n
  *            %http://tizen.org/privilege/network.get
- * @remark This API needs both privileges.
+ * @remark This function needs both privileges.
  * @param[in] wifi            The Wi-Fi handle
  * @param[in] ap              The access point handle
  * @param[in] callback        The callback function to be called \n
@@ -1258,7 +1258,7 @@ int wifi_manager_disconnect(wifi_manager_h wifi, wifi_manager_ap_h ap, wifi_mana
  * @privlevel public
  * @privilege %http://tizen.org/privilege/network.profile \n
  *            %http://tizen.org/privilege/network.get
- * @remark This API needs both privileges.
+ * @remark This function needs both privileges.
  * @param[in] wifi            The Wi-Fi handle
  * @param[in] ap              The access point handle
  * @param[in] callback        The callback function to be called \n
@@ -1286,7 +1286,7 @@ int wifi_manager_connect_by_wps_pbc(wifi_manager_h wifi,
  * @privlevel public
  * @privilege %http://tizen.org/privilege/network.profile \n
  *            %http://tizen.org/privilege/network.get
- * @remark This API needs both privileges.
+ * @remark This function needs both privileges.
  * @param[in] wifi            The Wi-Fi handle
  * @param[in] ap              The access point handle
  * @param[in] pin             The WPS PIN is a non-NULL string with length greater than 0 and less than or equal to 8
@@ -1315,7 +1315,7 @@ int wifi_manager_connect_by_wps_pin(wifi_manager_h wifi,
  * @privilege %http://tizen.org/privilege/network.set \n
  *            %http://tizen.org/privilege/network.get \n
  *            %http://tizen.org/privilege/network.profile
- * @remark This API needs all listed privileges.
+ * @remark This function needs all listed privileges.
  * @param[in] wifi      The Wi-Fi handle
  * @param[in] callback  The callback function to be called \n
  *                     This can be NULL if you don't want to get the notification.
@@ -1343,7 +1343,7 @@ int wifi_manager_connect_by_wps_pbc_without_ssid(wifi_manager_h wifi,
  * @privilege %http://tizen.org/privilege/network.set \n
  *            %http://tizen.org/privilege/network.get \n
  *            %http://tizen.org/privilege/network.profile
- * @remark This API needs all listed privileges.
+ * @remark This function needs all listed privileges.
  * @param[in] wifi      The Wi-Fi handle
  * @param[in] pin       The WPS PIN, a non-NULL string with length greater \n
  *                      than 0 and less than or equal to 8
@@ -1372,7 +1372,7 @@ int wifi_manager_connect_by_wps_pin_without_ssid(wifi_manager_h wifi,
  * @privlevel public
  * @privilege %http://tizen.org/privilege/network.set \n
  *            %http://tizen.org/privilege/network.get
- * @remark This API needs both privileges.
+ * @remark This function needs both privileges.
  * @param[in] wifi      The Wi-Fi handle
  * @return 0 on success, otherwise negative error value
  * @retval #WIFI_MANAGER_ERROR_NONE                 Successful
@@ -1392,7 +1392,7 @@ int wifi_manager_cancel_wps(wifi_manager_h wifi);
  * @privlevel public
  * @privilege %http://tizen.org/privilege/network.profile \n
  *            %http://tizen.org/privilege/network.get
- * @remark This API needs both privileges.
+ * @remark This function needs both privileges.
  * @param[in] wifi            The Wi-Fi handle
  * @param[in] ap              The access point handle
  * @return 0 on success, otherwise negative error value
@@ -1413,7 +1413,7 @@ int wifi_manager_forget_ap(wifi_manager_h wifi, wifi_manager_ap_h ap);
  * @privlevel public
  * @privilege %http://tizen.org/privilege/network.profile \n
  *            %http://tizen.org/privilege/network.get
- * @remark This API needs both privileges.
+ * @remark This function needs both privileges.
  * @param[in] wifi            The Wi-Fi handle
  * @param[in] ap              The access point handle
  * @return 0 on success, otherwise negative error value
@@ -2592,7 +2592,7 @@ int wifi_manager_ap_get_error_state(wifi_manager_ap_h ap, wifi_manager_error_e *
  * @retval #WIFI_MANAGER_ERROR_OUT_OF_MEMORY        Out of memory
  * @retval #WIFI_MANAGER_ERROR_NOT_SUPPORTED        Not supported
  * @see wifi_manager_config_destroy()
- * @pre This API needs wifi_manager_initialize() before use
+ * @pre This function needs wifi_manager_initialize() before use
  */
 int wifi_manager_config_create(wifi_manager_h wifi, const char *name,
                const char *passphrase, wifi_manager_security_type_e security_type, wifi_manager_config_h *config);
@@ -2688,7 +2688,7 @@ int wifi_manager_config_remove(wifi_manager_h wifi, wifi_manager_config_h config
  * @retval #WIFI_MANAGER_ERROR_INVALID_PARAMETER    Invalid parameter
  * @retval #WIFI_MANAGER_ERROR_PERMISSION_DENIED    Permission denied
  * @retval #WIFI_MANAGER_ERROR_NOT_SUPPORTED        Not supported
- * @pre This API needs wifi_manager_initialize() before use.
+ * @pre This function needs wifi_manager_initialize() before use.
  * @post This function invokes wifi_manager_config_list_cb().
  */
 int wifi_manager_config_foreach_configuration(wifi_manager_h wifi,