Add @remark description for wifi_manager_foreach_found_ap() 03/159103/7 accepted/tizen_3.0_common accepted/tizen_3.0_mobile accepted/tizen_3.0_tv accepted/tizen/3.0/common/20171109.103505 accepted/tizen/3.0/mobile/20171108.221500 accepted/tizen/3.0/tv/20171108.221504 submit/tizen_3.0/20171108.034841
authorSeonah Moon <seonah1.moon@samsung.com>
Tue, 7 Nov 2017 04:03:48 +0000 (13:03 +0900)
committertaesub kim <taesub.kim@samsung.com>
Wed, 8 Nov 2017 03:31:53 +0000 (12:31 +0900)
Change-Id: I9b00096d7a86d14c40b465b972d5dd2e68d3986d

include/wifi-manager.h

index d8d020a87441938920f2655dadb0569d10628de2..8f3c2a6fb6a5ed6e925574b15a1165f6d46eb3ed 100755 (executable)
@@ -672,6 +672,7 @@ int wifi_manager_get_connected_ap(wifi_manager_h wifi, wifi_manager_ap_h *ap);
  * @brief Gets the result of the scan.
  * @since_tizen 3.0
  * @privlevel public
+ * @remarks After a specific scan, the results are also included in the list for a while.
  * @privilege %http://tizen.org/privilege/network.get
  * @param[in] wifi                     The wifi handle
  * @param[in] callback         The callback to be called
@@ -689,6 +690,10 @@ int wifi_manager_foreach_found_ap(wifi_manager_h wifi, wifi_manager_found_ap_cb
 /**
  * @brief Gets the result of specific AP scan.
  * @since_tizen 3.0
+ * @remarks If you want to modify an AP handle in the specific scan results.
+ *          You have to use wifi_manager_foreach_found_ap()
+ *          instead of wifi_manager_foreach_found_specific_ap() after specific scan to get the results.
+ *          Because AP handle provided by wifi_manager_foreach_found_specific_ap() can't be modified.
  * @privlevel public
  * @privilege %http://tizen.org/privilege/network.get
  * @param[in] wifi                     The wifi handle
@@ -702,6 +707,7 @@ int wifi_manager_foreach_found_ap(wifi_manager_h wifi, wifi_manager_found_ap_cb
  * @retval #WIFI_MANAGER_ERROR_NOT_SUPPORTED   Not supported
  * @post This function invokes wifi_manager_found_ap_cb().
  * @see wifi_manager_scan_specific_ap()
+ * @see wifi_manager_foreach_found_ap()
  */
 int wifi_manager_foreach_found_specific_ap(wifi_manager_h wifi,
                wifi_manager_found_ap_cb callback, void *user_data);