From: MyoungJune Park Date: Tue, 10 Sep 2024 09:37:08 +0000 (+0900) Subject: Update API documentation X-Git-Tag: accepted/tizen/unified/20250116.113524~1 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fchanges%2F74%2F317474%2F6;p=platform%2Fcore%2Fapi%2Fwifi-manager.git Update API documentation Change-Id: I7dac9a3249e678edd122bf93423c268bce89479d Signed-off-by: MyoungJune Park --- diff --git a/doc/wifi_manager_doc.h b/doc/wifi_manager_doc.h index 1a4c65d..55105c6 100644 --- a/doc/wifi_manager_doc.h +++ b/doc/wifi_manager_doc.h @@ -27,7 +27,8 @@ /** * @defgroup CAPI_NETWORK_WIFI_MANAGER_MODULE Wi-Fi Manager - * @brief The Wi-Fi API provides functions for managing Wi-Fi and monitoring the state of Wi-Fi. + * @brief The Wi-Fi API offers functionalities for managing Wi-Fi connectivity and monitoring its status. + * * @ingroup CAPI_NETWORK_WIFI_PACKAGE * * @section CAPI_NETWORK_WIFI_MANAGER_MODULE_HEADER Required Header @@ -35,8 +36,9 @@ * * @section CAPI_NETWORK_WIFI_MANAGER_MODULE_OVERVIEW Overview * Wi-Fi allows your application to connect to a Wireless Local Area Network (WLAN) and to transfer data over the network. - * The Wi-Fi Manager enables your application to activate and deactivate a local Wi-Fi device, and to connect to a WLAN network - * in the infrastructure mode. + * With Wi-Fi, your application can establish a connection to a Wireless Local Area Network (WLAN) and facilitate data transmission across the network. + * + * The Wi-Fi Manager empowers your application to enable or disable a local Wi-Fi device, and to connect to a WLAN network in the infrastructure mode. * @section CAPI_NETWORK_WIFI_MANAGER_MODULE_FEATURE Related Features * This API is related with the following features:\n * - %http://tizen.org/feature/network.wifi\n @@ -60,9 +62,9 @@ * \#include * * @section CAPI_NETWORK_WIFI_MANAGER_MANAGEMENT_MODULE_OVERVIEW Overview - * To use Wifi Manager API, first create a wifi handle using wifi_manager_initialize(). After that, you can obtain wifi information. - * You should destroy the created wifi handle if you do not need it anymore. - * The Wi-Fi Manager provides functions for managing Wi-Fi. + * To utilize the Wi-fi Manager API, initially generate a wifi handle by invoking the 'wifi_manager_initialize()' function. Subsequently, you will be able to retrieve wifi information. + * If you no longer require the generated wifi handle, you must destroy it. + * The Wi-Fi Manager offers functionalities for managing Wi-Fi. * Using the Wi-Fi Manager, you can implement features that allow the users of your application to: * - Activate / Deactivate the Wi-Fi device * - Connect to the access point @@ -90,7 +92,7 @@ * \#include * * @section CAPI_NETWORK_WIFI_MANAGER_MONITOR_MODULE_OVERVIEW Overview - * The Wi-Fi Monitor allows monitoring the changes of Wi-Fi. + * The Wi-Fi Monitor enables tracking of Wi-Fi state changes. * @section CAPI_NETWORK_WIFI_MANAGER_MONITOR_MODULE_FEATURE Related Features * This API is related with the following features:\n * - %http://tizen.org/feature/network.wifi\n @@ -114,7 +116,7 @@ * \#include * * @section CAPI_NETWORK_WIFI_MANAGER_AP_MODULE_OVERVIEW Overview - * The Access Point API provides functions for managing the Access Point. You need to create the @a ap handle for using the functions. + * The Access Point API offers functionalities for managing the Access Point. You need to create the @a ap handle for using the functions. * You can use Wi-Fi information with the handle. * @section CAPI_NETWORK_WIFI_MANAGER_AP_MODULE_FEATURE Related Features * This API is related with the following features:\n @@ -139,7 +141,7 @@ * \#include * * @section CAPI_NETWORK_WIFI_MANAGER_AP_NETWORK_MODULE_OVERVIEW Overview - * The Connection Information API provides functions for managing the network information. You can manage the network information using the functions. + * The Connection Information API offers functionalities for managing network information. You can manage the network information using the functions. * @section CAPI_NETWORK_WIFI_MANAGER_AP_NETWORK_MODULE_FEATURE Related Features * This API is related with the following features:\n * - %http://tizen.org/feature/network.wifi\n @@ -156,7 +158,7 @@ /** * @defgroup CAPI_NETWORK_WIFI_MANAGER_AP_SECURITY_MODULE Security Information - * @brief The Security Information API provides functions for managing the Security information. + * @brief The Security Information API offers functionalities for managing security information. * @ingroup CAPI_NETWORK_WIFI_MANAGER_AP_MODULE * * @section CAPI_NETWORK_WIFI_MANAGER_AP_SECURITY_MODULE_HEADER Required Header @@ -187,7 +189,7 @@ * \#include * * @section CAPI_NETWORK_WIFI_MANAGER_AP_SECURITY_EAP_MODULE_OVERVIEW Overview - * The EAP API provides functions for managing the EAP information. You can manage the EAP information using the functions. + * The EAP API offers functionalities for managing EAP information. You can manage the EAP information using the functions. * @section CAPI_NETWORK_WIFI_MANAGER_AP_SECURITY_EAP_MODULE_FEATURE Related Features * This API is related with the following features:\n * - %http://tizen.org/feature/network.wifi\n @@ -205,14 +207,14 @@ /** * @defgroup CAPI_NETWORK_WIFI_MANAGER_CONFIG_MODULE Wi-Fi Configuration - * @brief The Configuration API provides functions for managing the configuration of Wi-Fi. + * @brief The Configuration API offers functionalities for managing the configuration of Wi-Fi. * @ingroup CAPI_NETWORK_WIFI_MANAGER_MODULE * * @section CAPI_NETWORK_WIFI_MANAGER_CONFIG_MODULE_HEADER Required Header * \#include * * @section CAPI_NETWORK_WIFI_MANAGER_CONFIG_MODULE_OVERVIEW Overview - * The Configuration API provides functions for managing the configuration of Wi-Fi. You can manage the configuration information using the functions. + * The Configuration API offers functionalities for managing the configuration of Wi-Fi. You can manage the configuration information using the functions. * @section CAPI_NETWORK_WIFI_MANAGER_CONFIG_MODULE_FEATURE Related Features * This API is related with the following features:\n * - %http://tizen.org/feature/network.wifi\n @@ -229,14 +231,14 @@ /** * @defgroup CAPI_NETWORK_WIFI_MANAGER_TDLS_MODULE Wi-Fi TDLS - * @brief The TDLS APIs for managing TDLS. + * @brief The TDLS API offers functionalities for managing TDLS. * @ingroup CAPI_NETWORK_WIFI_MANAGER_MODULE * * @section CAPI_NETWORK_WIFI_MANAGER_TDLS_MODULE_HEADER Required Header * \#include * * @section CAPI_NETWORK_WIFI_MANAGER_TDLS_MODULE_OVERVIEW Overview - * The TDLS APIs for managing TDLS. + * The The TDLS API offers functionalities for managing TDLS. * @section CAPI_NETWORK_WIFI_MANAGER_TDLS_MODULE_FEATURE Related Features * This API is related with the following features:\n * - %http://tizen.org/feature/network.wifi.tdls\n diff --git a/include/wifi-manager.h b/include/wifi-manager.h index 7eeba5c..2d9d5d9 100755 --- a/include/wifi-manager.h +++ b/include/wifi-manager.h @@ -842,6 +842,7 @@ typedef enum { /** * @brief Called for each found access point. + * @details This callback function is used in conjunction with `wifi_manager_foreach_found_ap()` or `wifi_manager_foreach_found_specific_ap()` to iterate through all discovered access points. * @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 @a ap with wifi_manager_ap_clone(). * @param[in] ap The access point @@ -871,6 +872,7 @@ typedef void(*wifi_manager_scan_finished_cb)(wifi_manager_error_e error_code, vo /** * @brief Called when the scanning state is changed. + * @details This callback function is registered using `wifi_manager_set_scan_state_changed_cb()` and will be called whenever the scanning state of the Wi-Fi manager changes. * @since_tizen 4.0 * @param[in] state The wifi scanning state * @param[in] user_data The user data passed from the callback registration function @@ -1000,6 +1002,7 @@ typedef void(*wifi_manager_bssid_scan_finished_cb)(wifi_manager_error_e error_co /** * @brief Called when the device state is changed. + * @details This callback function is registered using `wifi_manager_set_device_state_changed_cb()` and will be called whenever the state of the Wi-Fi device changes. * @since_tizen 3.0 * @param[in] state The device state * @param[in] user_data The user data passed from the callback registration function @@ -1010,6 +1013,7 @@ typedef void(*wifi_manager_device_state_changed_cb)(wifi_manager_device_state_e /** * @brief Called when the connection state is changed. + * @details This callback function is registered using `wifi_manager_set_connection_state_changed_cb()` and will be called whenever the connection state of a Wi-Fi access point changes. * @since_tizen 3.0 * @param[in] state The connection state * @param[in] ap The access point @@ -1021,6 +1025,7 @@ typedef void(*wifi_manager_connection_state_changed_cb)(wifi_manager_connection_ /** * @brief Called when the IP conflict state is changed. + * @details This callback function is registered using `wifi_manager_set_ip_conflict_cb()` and will be called whenever the IP conflict state changes. * @since_tizen 5.0 * @remarks @a mac should not be freed. @a mac is available only in the callback. To use * outside the callback, make a copy. @@ -1034,6 +1039,7 @@ typedef void(*wifi_manager_ip_conflict_cb)(char *mac, wifi_manager_ip_conflict_s /** * @brief Called when the RSSI of connected Wi-Fi is changed. + * @details This callback function is registered using `wifi_manager_set_rssi_level_changed_cb()` and will be called whenever the RSSI level of the connected Wi-Fi network changes. * @since_tizen 3.0 * @param[in] rssi_level The level of RSSI * @param[in] user_data The user data passed from the callback registration function @@ -1044,6 +1050,7 @@ typedef void(*wifi_manager_rssi_level_changed_cb)(wifi_manager_rssi_level_e rssi /** * @brief Called when the Wi-Fi Module state is changed. + * @details This callback function is registered using `wifi_manager_set_module_state_changed_cb()` and will be called whenever the state of the Wi-Fi module changes. * @since_tizen 4.0 * @param[in] wifi_module_state The Wi-Fi Module state * @param[in] user_data The user data passed from the callback registration function @@ -1064,6 +1071,7 @@ typedef void(*wifi_manager_module_state_changed_cb)(wifi_manager_module_state_e /** * @brief Called for each found access point configuration. + * @details This callback function is used in conjunction with `wifi_manager_config_foreach_configuration()` to iterate through all saved access point configurations. * @since_tizen 3.0 * @remarks @a config is valid only in this function. In order to use @a config outside this function, you must copy the config with wifi_manager_config_clone(). * @@ -1087,6 +1095,8 @@ typedef bool (*wifi_manager_config_list_cb)(const wifi_manager_config_h config, /** * @brief Called when the Wi-Fi TDLS state is changed. + * @details This callback function is registered using `wifi_manager_tdls_set_state_changed_cb()` and + * will be called whenever the state of a TDLS connection changes. * @since_tizen 3.0 * * @param[in] state The TDLS state @@ -1100,6 +1110,8 @@ typedef void(*wifi_manager_tdls_state_changed_cb)(wifi_manager_tdls_state_e stat /** * @brief Called when the Wi-Fi TDLS is discovered. + * @details This callback function is registered using `wifi_manager_tdls_set_discovered_cb()` and + * will be called when the TDLS discovery process is completed. * @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 @@ -1121,7 +1133,10 @@ typedef void(*wifi_manager_tdls_discovered_cb)(wifi_manager_tdls_discovery_state */ /** - * @brief Initializes Wi-Fi. + * @brief Initializes the Wi-Fi service and prepares it for use. + * @details This function initializes the Wi-Fi service, + * allocating necessary resources and preparing it for subsequent Wi-Fi management operations such as scanning for networks, + * connecting to a network, or retrieving Wi-Fi information. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.get @@ -1140,7 +1155,8 @@ typedef void(*wifi_manager_tdls_discovered_cb)(wifi_manager_tdls_discovery_state int wifi_manager_initialize(wifi_manager_h *wifi); /** - * @brief Deinitializes Wi-Fi. + * @brief Terminates the Wi-Fi service and releases all resources associated with it. + * @details This function deinitializes the Wi-Fi service, releasing all allocated resources and terminating any ongoing operations related to Wi-Fi management. * @since_tizen 3.0 * @param[in] wifi The Wi-Fi handle * @return 0 on success, otherwise negative error value @@ -1165,6 +1181,9 @@ int wifi_manager_deinitialize(wifi_manager_h wifi); /** * @brief Activates Wi-Fi asynchronously. + * @details This function initiates the process to activate the Wi-Fi service. + * When Wi-Fi is activated, the Wi-Fi radio is turned on, + * and the device becomes capable of connecting to wireless networks. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.set \n @@ -1192,6 +1211,8 @@ int wifi_manager_activate(wifi_manager_h wifi, wifi_manager_activated_cb callbac /** * @brief Activates Wi-Fi asynchronously and displays Wi-Fi picker (popup) when Wi-Fi is not automatically connected. + * @details This function activates the Wi-Fi service and, if Wi-Fi does not automatically connect to a known network, + * it will display a Wi-Fi picker (popup) allowing the user to manually select a network to connect to. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.set \n @@ -1220,6 +1241,8 @@ int wifi_manager_activate_with_wifi_picker_tested(wifi_manager_h wifi, /** * @brief Deactivates Wi-Fi asynchronously. + * @details This function initiates the process to deactivate the Wi-Fi service. When Wi-Fi is deactivated, + * the Wi-Fi radio is turned off, and the device will no longer be able to connect to wireless networks. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.set \n @@ -1245,6 +1268,8 @@ int wifi_manager_deactivate(wifi_manager_h wifi, wifi_manager_deactivated_cb cal /** * @brief Checks whether Wi-Fi is activated. + * @details This function checks the status of the Wi-Fi service to determine if it is currently activated. + * If Wi-Fi is activated, it means that the Wi-Fi radio is turned on and ready to connect to wireless networks. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.get @@ -1263,6 +1288,8 @@ int wifi_manager_is_activated(wifi_manager_h wifi, bool *activated); /** * @brief Gets the local MAC address. + * @details This function queries the Wi-Fi manager to obtain the MAC address of the Wi-Fi device. + * The MAC address is a unique identifier assigned to network interfaces for communications on a physical network segment. * @since_tizen 3.0 * @remarks You must release @a mac_address using free(). * @param[in] wifi The Wi-Fi handle @@ -1278,6 +1305,8 @@ int wifi_manager_get_mac_address(wifi_manager_h wifi, char **mac_address); /** * @brief Gets the name of the network interface. + * @details This function queries the Wi-Fi manager to obtain the name of the network interface that is currently being used for the Wi-Fi connection. + * The network interface name is typically a string identifier like 'wlan0' or 'eth0', which can be used for various networking operations. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.get @@ -1297,6 +1326,8 @@ int wifi_manager_get_network_interface_name(wifi_manager_h wifi, char **name); /** * @brief Starts scan asynchronously. + * @details This function starts a Wi-Fi scan to discover all available access points (APs) in the vicinity. + * The scan results will include information about each detected AP, such as its SSID, signal strength, and security type. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.set \n @@ -1319,6 +1350,8 @@ int wifi_manager_scan(wifi_manager_h wifi, wifi_manager_scan_finished_cb callbac /** * @brief Gets the Wi-Fi scan state. + * @details This function queries the Wi-Fi manager to determine the current state of the Wi-Fi scan operation. + * The scan state indicates whether a scan is currently in progress or if the results from the last scan are still valid. * @since_tizen 4.0 * @param[in] wifi The Wi-Fi handle * @param[in] scan_state The Wi-Fi scan state @@ -1333,6 +1366,9 @@ int wifi_manager_get_scan_state(wifi_manager_h wifi, wifi_manager_scan_state_e * /** * @brief Starts specific AP scan, asynchronously. + * @details This function starts a Wi-Fi scan targeting a specific access point (AP) with the given ESSID (Extended Service Set Identifier). + * Unlike a regular scan, which searches for all available APs in the vicinity, a specific scan focuses on a single AP with the specified ESSID, + * potentially improving scan performance and reducing scan time. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.set \n @@ -1357,6 +1393,8 @@ int wifi_manager_scan_specific_ap(wifi_manager_h wifi, /** * @brief Creates a Wi-Fi specific AP scan handle. + * @details This function creates a new specific AP scan handle, which can be used to configure and initiate specific AP scans. + * The handle is required for setting up specific scan parameters such as SSID and channel frequency. * @since_tizen 4.0 * @remarks You must release @a specific_scan using wifi_manager_specific_scan_destroy(). * @param[in] wifi The Wi-Fi handle @@ -1375,6 +1413,9 @@ int wifi_manager_specific_scan_create(wifi_manager_h wifi, wifi_manager_specific /** * @brief Destroys a Wi-Fi specific AP scan handle. + * @details This function releases the memory allocated for a specific AP scan handle, + * which was created using `wifi_manager_specific_scan_create()`. + * It is important to destroy the handle when it is no longer needed to avoid memory leaks. * @since_tizen 4.0 * @param[in] wifi The Wi-Fi handle * @param[in] specific_scan The Wi-Fi specific AP scan handle @@ -1392,6 +1433,8 @@ int wifi_manager_specific_scan_destroy(wifi_manager_h wifi, wifi_manager_specifi /** * @brief Gets the maximum number of SSIDs supported by the Wi-Fi chipset for the scan operation. + * @details This function queries the Wi-Fi manager to determine the maximum number of SSIDs that the Wi-Fi chipset can support during a single scan operation. + * This value is important when configuring specific AP scans, as it limits the number of SSIDs that can be targeted in a single scan request. * @since_tizen 5.5 * @privlevel public * @privilege %http://tizen.org/privilege/network.get @@ -1411,6 +1454,9 @@ int wifi_manager_specific_scan_get_max_ssids(wifi_manager_h wifi, int *max_scan_ /** * @brief Sets the SSID of a specific AP scan. + * @details This function sets the SSID for a specific AP scan, which determines the target access point to be scanned. + * By specifying the SSID, the scan can focus on a particular AP rather than scanning for all available APs in the vicinity, + * potentially improving scan performance and reducing scan time. * @since_tizen 4.0 * @param[in] specific_scan The Wi-Fi specific AP scan handle * @param[in] essid The SSID of specific AP scan @@ -1427,6 +1473,8 @@ int wifi_manager_specific_scan_set_ssid(wifi_manager_specific_scan_h specific_sc /** * @brief Sets the channel frequency of a specific AP scan. + * @details This function sets the channel frequency for a specific AP scan, which determines the radio frequency band on which the scan will be performed. + * By specifying the channel frequency, the scan can be focused on a particular frequency band, potentially improving scan performance and reducing scan time. * @since_tizen 4.0 * @param[in] specific_scan The Wi-Fi specific AP scan handle * @param[in] freq The channel frequency of specific AP scan @@ -1442,6 +1490,10 @@ int wifi_manager_specific_scan_set_freq(wifi_manager_specific_scan_h specific_sc /** * @brief Starts multi SSID and multi channel specific scan, asynchronously. + * @details This function starts a Wi-Fi scan targeting multiple specific access points (APs) across multiple channels simultaneously. + * Unlike a regular scan, which searches for all available APs in the vicinity, + * a specific scan focuses on a predefined set of APs, which can improve scan efficiency and reduce scan time. + * The multi-SSID and multi-channel specific scan extends this concept further by allowing the scan to target multiple sets of APs across different channels at once. * @since_tizen 4.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.set \n @@ -1468,6 +1520,10 @@ int wifi_manager_specific_ap_start_multi_scan(wifi_manager_h wifi, /** * @brief Flushes BSS entries from the cache. + * @details This function removes all previously discovered BSS entries from the Wi-Fi manager's internal cache. + * BSS entries include information about nearby Wi-Fi access points (APs) that have been scanned and stored by the Wi-Fi manager. + * By flushing these entries, the Wi-Fi manager effectively forgets about previously discovered APs, + * which can be useful in scenarios where the environment has changed significantly or when privacy concerns dictate that old scan results should be discarded. * @since_tizen 7.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.set \n @@ -1486,6 +1542,10 @@ int wifi_manager_flush_bss(wifi_manager_h wifi); /** * @brief Connects to the hidden AP, asynchronously. + * @details This function attempts to connect to a hidden Wi-Fi access point (AP) with the specified ESSID, security type, and passphrase. + * Hidden APs do not broadcast their presence, so the ESSID must be explicitly provided to the function. + * The connection process is performed asynchronously, meaning that the function returns immediately, + * and the result of the connection attempt is reported via the provided callback function. * @since_tizen 4.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.set \n @@ -1515,6 +1575,8 @@ int wifi_manager_connect_hidden_ap(wifi_manager_h wifi, /** * @brief Gets the handle of the connected access point. + * @details This function retrieves the handle of the access point to which the Wi-Fi interface is currently connected. + * If there is no active connection, the function will return an error. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.get @@ -1535,6 +1597,8 @@ int wifi_manager_get_connected_ap(wifi_manager_h wifi, wifi_manager_ap_h *ap); /** * @brief Gets the result of the scan. + * @details This function iterates through the list of access points found during a general Wi-Fi scan and provides their details to the caller via the provided callback function. + * A general Wi-Fi scan searches for all available access points in the vicinity, regardless of whether they are known or unknown to the device. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.get @@ -1554,6 +1618,10 @@ int wifi_manager_foreach_found_ap(wifi_manager_h wifi, wifi_manager_found_ap_cb /** * @brief Gets the result of specific AP scan. + * @details This function iterates through the list of access points found during a specific access point scan + * and provides their details to the caller via the provided callback function. + * A specific access point scan is used to focus on a particular access point, + * rather than scanning all available access points in the vicinity. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.get @@ -1575,6 +1643,8 @@ int wifi_manager_foreach_found_specific_ap(wifi_manager_h wifi, /** * @brief Gets the result of the BSSID scan (i.e. BSSID, ESSID & RSSI). + * @details This function iterates through the list of access points found during a BSSID scan and provides their details to the caller via the provided callback function. + * The BSSID scan focuses on identifying access points based on their unique MAC addresses (BSSID), allowing for more precise identification compared to a regular scan. * @since_tizen 4.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.get @@ -1598,6 +1668,9 @@ int wifi_manager_foreach_found_bssid_ap(wifi_manager_h wifi, /** * @brief Connects to the access point asynchronously. + * @details This function initiates a connection to the specified Wi-Fi access point. + * The connection process is performed asynchronously, meaning that the function returns immediately, + * and the result of the connection attempt is reported via the provided callback function. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.set \n @@ -1627,6 +1700,9 @@ int wifi_manager_connect(wifi_manager_h wifi, wifi_manager_ap_h ap, wifi_manager /** * @brief Disconnects to the access point asynchronously. + * @details This function disrupts the existing connection to the specified Wi-Fi access point. + * The disconnection process is performed asynchronously, meaning that the function returns immediately, + * and the result of the disconnection attempt is reported via the provided callback function. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.set \n @@ -1655,6 +1731,9 @@ int wifi_manager_disconnect(wifi_manager_h wifi, wifi_manager_ap_h ap, wifi_mana /** * @brief Connects to the access point with WPS PBC asynchronously. + * @details This function initiates a connection to a Wi-Fi access point using WPS PBC authentication. + * The connection process is performed asynchronously, meaning that the function returns immediately, + * and the result of the connection attempt is reported via the provided callback function. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.profile \n @@ -1685,6 +1764,9 @@ int wifi_manager_connect_by_wps_pbc(wifi_manager_h wifi, /** * @brief Connects to the access point with WPS PIN asynchronously. + * @details This function initiates a connection to a Wi-Fi access point using WPS PIN authentication. + * The connection process is performed asynchronously, meaning that the function returns immediately, + * and the result of the connection attempt is reported via the provided callback function. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.profile \n @@ -1715,6 +1797,9 @@ int wifi_manager_connect_by_wps_pin(wifi_manager_h wifi, /** * @brief Connects to the access point with WPS PBC without entering SSID. + * @details This function initiates a connection to a Wi-Fi access point using WPS PBC authentication. + * The SSID of the access point does not need to be known; + * the Wi-Fi module will search for and connect to the access point based on the WPS PBC signal. * @since_tizen 4.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.set \n @@ -1745,6 +1830,9 @@ int wifi_manager_connect_by_wps_pbc_without_ssid(wifi_manager_h wifi, /** * @brief Connects to the access point with WPS PIN without entering SSID. + * @details This function initiates a connection to a Wi-Fi access point using WPS PIN authentication. + * The SSID of the access point does not need to be known; + * the Wi-Fi module will search for and connect to the access point based on the provided WPS PIN. * @since_tizen 4.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.set \n @@ -1777,6 +1865,8 @@ int wifi_manager_connect_by_wps_pin_without_ssid(wifi_manager_h wifi, /** * @brief Stops ongoing WPS provisioning / disconnects from the connected access point. + * @details This function stops any ongoing WPS provisioning process initiated by `wifi_manager_start_wps()` or disconnects + * from the currently connected access point if there is no ongoing WPS provisioning. * @since_tizen 4.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.set \n @@ -1796,6 +1886,8 @@ int wifi_manager_cancel_wps(wifi_manager_h wifi); /** * @brief Gets the WPS generated PIN code. + * @details This function queries the Wi-Fi manager to obtain the WPS-generated PIN code. + * The retrieved PIN code can be used for WPS-based authentication when connecting to a Wi-Fi access point. * @since_tizen 5.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.get @@ -1836,6 +1928,8 @@ int wifi_manager_forget_ap(wifi_manager_h wifi, wifi_manager_ap_h ap); /** * @brief Deletes stored access point's information and disconnects from it if connected, asynchronously. + * @details This function initiates an asynchronous process to delete the stored information of the specified access point and disconnect from it if currently connected. + * The result of the operation is reported via the provided callback function. * @since_tizen 5.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.profile \n @@ -1861,7 +1955,7 @@ int wifi_manager_forget_ap_async(wifi_manager_h wifi, wifi_manager_ap_h ap, /** * @brief Updates an existing AP. * @details When a AP is changed, these changes will be not applied to the Connection Manager immediately. - * When you call this function, your changes affect the Connection Manager and the existing AP is updated. + * When you call this function, your changes affect the Connection Manager and the existing AP is updated. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.profile \n @@ -1881,6 +1975,8 @@ int wifi_manager_update_ap(wifi_manager_h wifi, wifi_manager_ap_h ap); /** * @brief Adds the Wi-Fi Vendor Specific Information Element (VSIE) to a specific frame type. + * @details This function adds the specified VSIE data to the given frame ID. + * The VSIE data will be included in the corresponding frame when transmitted by the Wi-Fi module. * @since_tizen 5.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.set @@ -1908,6 +2004,8 @@ int wifi_manager_add_vsie(wifi_manager_h wifi, /** * @brief Gets the Wi-Fi Vendor Specific Information Elements (VSIE) from a specific frame. + * @details This function retrieves the VSIE data associated with the given frame ID. + * The retrieved VSIE data can be used to inspect or modify the contents of the VSIE element within the specified frame. * @since_tizen 5.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.get @@ -1936,6 +2034,8 @@ int wifi_manager_get_vsie(wifi_manager_h wifi, /** * @brief Removes the Wi-Fi Vendor Specific Information Element (VSIE) from specific frame. + * @details This function removes the specified VSIE data from the given frame ID. + * The VSIE data will no longer be included in the corresponding frame when transmitted by the Wi-Fi module. * @since_tizen 5.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.set @@ -1973,6 +2073,8 @@ int wifi_manager_remove_vsie(wifi_manager_h wifi, /** * @brief Gets the connection state. + * @details This function queries the Wi-Fi manager to obtain the current connection state of the Wi-Fi network associated with the given Wi-Fi handle. + * The retrieved connection state can be one of the following: DISCONNECTED, CONNECTED, or CONNECTING. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.get @@ -1990,6 +2092,9 @@ int wifi_manager_get_connection_state(wifi_manager_h wifi, /** * @brief Registers the callback called when the device state is changed. + * @details This function registers a callback function to monitor changes in the Wi-Fi device state. + * When the Wi-Fi device state changes (e.g., enabled, disabled, or enabling/disabling in progress), + * the registered callback function will be invoked with the updated device state and the provided user data. * @since_tizen 3.0 * @param[in] wifi The Wi-Fi handle * @param[in] callback The callback function to be called @@ -2006,6 +2111,8 @@ int wifi_manager_set_device_state_changed_cb(wifi_manager_h wifi, /** * @brief Unregisters the callback called when the device state is changed. + * @details This function removes the previously registered callback for monitoring changes in the Wi-Fi device state. + * The callback will no longer be invoked when the device state changes after this function is called. * @since_tizen 3.0 * @param[in] wifi The Wi-Fi handle * @return 0 on success, otherwise negative error value @@ -2019,6 +2126,8 @@ int wifi_manager_unset_device_state_changed_cb(wifi_manager_h wifi); /** * @brief Registers the callback called when the background scan is finished. + * @details This function registers a callback function to monitor the completion of background scans initiated by the Wi-Fi manager. + * When a background scan finishes, the registered callback function will be invoked with the scan results and the provided user data. * @since_tizen 3.0 * @param[in] wifi The Wi-Fi handle * @param[in] callback The callback function to be called @@ -2035,6 +2144,8 @@ int wifi_manager_set_background_scan_cb(wifi_manager_h wifi, /** * @brief Unregisters the callback called when the scan is finished. + * @details This function removes the previously registered callback for monitoring the completion of background scans initiated by the Wi-Fi manager. + * The callback will no longer be invoked when a background scan finishes after this function is called. * @since_tizen 3.0 * @param[in] wifi The Wi-Fi handle * @return 0 on success, otherwise negative error value @@ -2048,6 +2159,9 @@ int wifi_manager_unset_background_scan_cb(wifi_manager_h wifi); /** * @brief Registers the callback called when the scanning state is changed. + * @details This function registers a callback function to monitor changes in the scanning state of the Wi-Fi network. + * When the scanning state changes (e.g., scan started or scan finished), + * the registered callback function will be invoked with the updated scanning state and the provided user data. * @since_tizen 4.0 * @param[in] wifi The Wi-Fi handle * @param[in] callback The callback function to be called @@ -2064,6 +2178,8 @@ int wifi_manager_set_scan_state_changed_cb(wifi_manager_h wifi, /** * @brief Unregisters the callback called when the scanning state is changed. + * @details This function removes the previously registered callback for monitoring changes in the scanning state of the Wi-Fi network. + * The callback will no longer be invoked when the scanning state changes after this function is called. * @since_tizen 4.0 * @param[in] wifi The Wi-Fi handle * @return 0 on success, otherwise negative error value @@ -2077,6 +2193,9 @@ int wifi_manager_unset_scan_state_changed_cb(wifi_manager_h wifi); /** * @brief Registers the callback called when the connection state is changed. + * @details This function registers a callback function to monitor changes in the connection state of the Wi-Fi network. + * When the connection state changes (e.g., connected, disconnected, or connection failure), + * the registered callback function will be invoked with the updated connection state and the provided user data. * @since_tizen 3.0 * @param[in] wifi The Wi-Fi handle * @param[in] callback The callback function to be called @@ -2093,6 +2212,8 @@ int wifi_manager_set_connection_state_changed_cb(wifi_manager_h wifi, /** * @brief Unregisters the callback called when the connection state is changed. + * @details This function removes the previously registered callback for monitoring changes in the connection state of the Wi-Fi network. + * The callback will no longer be invoked when the connection state changes after this function is called. * @since_tizen 3.0 * @param[in] wifi The Wi-Fi handle * @return 0 on success, otherwise negative error value @@ -2106,6 +2227,8 @@ int wifi_manager_unset_connection_state_changed_cb(wifi_manager_h wifi); /** * @brief Registers callback called when the RSSI of connected Wi-Fi is changed. + * @details This function registers a callback function to monitor changes in the Received Signal Strength Indication (RSSI) level of the currently connected Wi-Fi network. + * When the RSSI level changes, the registered callback function will be invoked with the updated RSSI level and the provided user data. * @since_tizen 3.0 * @param[in] wifi The Wi-Fi handle * @param[in] callback The callback function to be called @@ -2122,6 +2245,8 @@ int wifi_manager_set_rssi_level_changed_cb(wifi_manager_h wifi, /** * @brief Unregisters callback called when the RSSI of connected Wi-Fi is changed. + * @details This function removes the previously registered callback for monitoring changes in the Received Signal Strength Indication (RSSI) level of the currently connected Wi-Fi network. + * The callback will no longer be invoked when the RSSI level changes after this function is called. * @since_tizen 3.0 * @param[in] wifi The Wi-Fi handle * @return 0 on success, otherwise negative error value @@ -2134,6 +2259,9 @@ int wifi_manager_unset_rssi_level_changed_cb(wifi_manager_h wifi); /** * @brief Registers a callback called when the Wi-Fi Module state is changed. + * @details This function registers a callback function to monitor changes in the Wi-Fi module state. + * When the state of the Wi-Fi module changes (e.g., enabled or disabled), + * the registered callback function will be invoked with the updated state and the provided user data. * @since_tizen 4.0 * @param[in] wifi The Wi-Fi handle * @param[in] callback The callback function to be called @@ -2153,6 +2281,8 @@ int wifi_manager_set_module_state_changed_cb(wifi_manager_h wifi, /** * @brief Unregisters the callback called when the Wi-Fi Module state is changed. + * @details This function removes the previously registered callback for monitoring changes in the Wi-Fi module state. + * The callback will no longer be invoked when the Wi-Fi module state changes after this function is called. * @since_tizen 4.0 * @param[in] wifi The Wi-Fi handle * @return @c 0 on success, otherwise negative error value @@ -2169,6 +2299,9 @@ int wifi_manager_unset_module_state_changed_cb(wifi_manager_h wifi); /** * @brief Gets the Wi-Fi Module state. + * @details This function retrieves the current state of the Wi-Fi module. + * The Wi-Fi module state indicates whether the Wi-Fi hardware is enabled or disabled. + * This information is useful for determining if the device is capable of connecting to wireless networks. * @since_tizen 4.0 * @param[in] wifi The Wi-Fi handle * @param[out] state The Wi-Fi Module state @@ -2184,6 +2317,9 @@ int wifi_manager_get_module_state(wifi_manager_h wifi, wifi_manager_module_state /** * @brief Starts BSSID scan asynchronously. + * @details This function starts a BSSID (Basic Service Set Identifier) scan to discover wireless access points. + * A BSSID scan focuses on finding specific access points based on their MAC addresses rather than scanning for all available networks. + * The scan is performed asynchronously, and the result is reported through the provided callback function. * @since_tizen 4.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.set \n @@ -2217,6 +2353,9 @@ int wifi_manager_bssid_scan(wifi_manager_h wifi, /** * @brief Creates the access point handle. + * @details This function creates a new access point handle for a visible wireless network. + * The ESSID (Extended Service Set Identifier) should be provided as a null-terminated string and can be encoded in UTF-8. + * The created access point handle can be used to connect to the specified wireless network using the Wi-Fi handle. * @since_tizen 3.0 * @remarks You must release @a ap using wifi_manager_ap_destroy(). * @param[in] wifi The Wi-Fi handle @@ -2235,6 +2374,10 @@ int wifi_manager_ap_create(wifi_manager_h wifi, const char *essid, wifi_manager_ /** * @brief Creates the hidden access point handle. + * @details This function creates a new access point handle for a hidden wireless network. + * Hidden networks do not broadcast their SSID (Service Set Identifier), + * so you need to provide the ESSID (Extended Service Set Identifier) explicitly when creating the access point handle. + * The ESSID should be a null-terminated string and can be encoded in UTF-8. * @since_tizen 3.0 * @remarks You must release @a ap using wifi_manager_ap_destroy(). * @param[in] wifi The Wi-Fi handle @@ -2252,6 +2395,8 @@ int wifi_manager_ap_hidden_create(wifi_manager_h wifi, const char *essid, wifi_m /** * @brief Destroys the access point handle. + * @details This function releases all resources allocated for the given access point handle. + * After calling this function, the access point handle becomes invalid and cannot be used for any further operations. * @since_tizen 3.0 * @param[in] ap The access point handle * @return 0 on success, otherwise negative error value @@ -2264,6 +2409,9 @@ int wifi_manager_ap_destroy(wifi_manager_ap_h ap); /** * @brief Clones the access point handle. + * @details This function creates a new access point handle that is a copy of the given access point handle. + * The cloned access point handle contains the same information as the original handle, + * allowing you to work with the same access point data without modifying the original handle. * @since_tizen 3.0 * @remarks You must release @a cloned_ap using wifi_manager_ap_destroy(). * @param[out] cloned_ap The cloned access point handle @@ -2280,6 +2428,10 @@ int wifi_manager_ap_clone(wifi_manager_ap_h *cloned_ap, wifi_manager_ap_h origin /** * @brief Refreshes the access point information. + * @details This function refreshes the access point information. + * Access point information can change over time due to various factors such as changes in the environment, + * network configuration updates, or other network events. + * By calling this function, you ensure that the latest information about the access point is retrieved and stored in the given access point handle. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.get @@ -2309,6 +2461,10 @@ int wifi_manager_ap_refresh(wifi_manager_ap_h ap); /** * @brief Gets ESSID (Extended Service Set Identifier). + * @details This function retrieves the Extended Service Set Identifier (ESSID) for the access point. + * The ESSID is a unique identifier assigned to a group of wireless access points that form an extended service set, + * typically represented as a sequence of characters (e.g., "MyHomeNetwork"). + * In most cases, the ESSID is identical to the SSID of the primary access point within the extended service set. * @since_tizen 3.0 * @remarks You must release @a essid using free(). * @param[in] ap The access point handle @@ -2324,6 +2480,9 @@ int wifi_manager_ap_get_essid(wifi_manager_ap_h ap, char **essid); /** * @brief Gets raw SSID (Service Set Identifier). + * @details This function retrieves the raw Service Set Identifier (SSID) for the access point. + * The SSID is a unique identifier assigned to a wireless network, typically represented as a sequence of characters (e.g., "MyHomeNetwork"). + * This function returns the raw SSID as a byte array, allowing direct access to the underlying data without any character encoding considerations. * @since_tizen 4.0 * @remarks You must release @a ssid using free(). * @param[in] ap The access point handle @@ -2340,6 +2499,9 @@ int wifi_manager_ap_get_raw_ssid(wifi_manager_ap_h ap, char **ssid, int *ssid_le /** * @brief Gets BSSID (Basic Service Set Identifier). + * @details This function retrieves the Basic Service Set Identifier (BSSID) for the access point. + * The BSSID is a unique identifier assigned to each wireless access point, + * consisting of a MAC address formatted as a string (e.g., "00:1A:2B:3C:4D:5E"). * @since_tizen 3.0 * @remarks You must release @a bssid using free(). * @param[in] ap The access point handle @@ -2355,6 +2517,9 @@ int wifi_manager_ap_get_bssid(wifi_manager_ap_h ap, char **bssid); /** * @brief Gets the RSSI. + * @details This function retrieves the Received Signal Strength Indication (RSSI) value for the access point. + * The RSSI value indicates the strength of the received signal from the access point, measured in decibels relative to milliwatts (dBm). + * A higher RSSI value generally indicates a stronger signal and better connection quality. * @since_tizen 3.0 * @param[in] ap The access point handle * @param[out] rssi The RSSI value (in dBm) @@ -2369,6 +2534,9 @@ int wifi_manager_ap_get_rssi(wifi_manager_ap_h ap, int *rssi); /** * @brief Gets the RSSI level. + * @details This function retrieves the Received Signal Strength Indication (RSSI) level for the access point. + * The RSSI level indicates the strength of the received signal from the access point, + * which can be used to determine the quality of the wireless connection. * @since_tizen 4.0 * @param[in] ap The access point handle * @param[out] rssi_level The RSSI level @@ -2383,6 +2551,8 @@ int wifi_manager_ap_get_rssi_level(wifi_manager_ap_h ap, wifi_manager_rssi_level /** * @brief Gets the frequency band (MHz). + * @details This function retrieves the frequency band (in megahertz, MHz) for the access point. + * The frequency band indicates the specific radio frequency range used by the access point to transmit and receive wireless signals. * @since_tizen 3.0 * @param[in] ap The access point handle * @param[out] frequency The frequency @@ -2397,6 +2567,8 @@ int wifi_manager_ap_get_frequency(wifi_manager_ap_h ap, int *frequency); /** * @brief Gets the max speed (Mbps). + * @details This function retrieves the maximum achievable speed (in megabits per second, Mbps) for the access point. + * The maximum speed indicates the highest possible data transfer rate that can be achieved when connected to the access point. * @since_tizen 3.0 * @param[in] ap The access point handle * @param[out] max_speed The max speed @@ -2411,6 +2583,8 @@ int wifi_manager_ap_get_max_speed(wifi_manager_ap_h ap, int *max_speed); /** * @brief Checks whether the access point is favorite or not. + * @details This function determines whether the access point is marked as a favorite or not. + * A favorite access point is one that the user has explicitly chosen to connect to frequently or has saved for future use. * @since_tizen 3.0 * @param[in] ap The access point handle * @param[out] favorite @c true if access point is favorite, @@ -2426,6 +2600,9 @@ int wifi_manager_ap_is_favorite(wifi_manager_ap_h ap, bool *favorite); /** * @brief Checks whether the access point is passpoint or not. + * @details This function determines whether the access point is a Passpoint or not. + * A Passpoint access point is a type of Wi-Fi hotspot that supports the Hotspot 2.0 standard, + * providing seamless and secure connectivity across various networks. * @since_tizen 3.0 * @param[in] ap The access point handle * @param[out] passpoint @c true if access point is passpoint, @@ -2441,6 +2618,8 @@ int wifi_manager_ap_is_passpoint(wifi_manager_ap_h ap, bool *passpoint); /** * @brief Checks whether the access point is hidden or not. + * @details This function determines whether the access point is hidden or not. + * A hidden access point does not broadcast its SSID (Service Set Identifier), making it less visible to potential clients. * @since_tizen 5.5 * @param[in] ap The access point handle * @param[out] is_hidden @c true if the access point is hidden, @@ -2456,6 +2635,8 @@ int wifi_manager_ap_is_hidden(wifi_manager_ap_h ap, bool *is_hidden); /** * @brief Gets the connection state. + * @details This function retrieves the current connection state of the access point. + * The connection state indicates whether the access point is currently connected, connecting, or disconnected. * @since_tizen 3.0 * @param[in] ap The access point handle * @param[out] state The connection state @@ -2470,6 +2651,8 @@ int wifi_manager_ap_get_connection_state(wifi_manager_ap_h ap, wifi_manager_conn /** * @brief Gets the config type of IP. + * @details This function retrieves the configuration type of the IP for the specified address family. + * The IP configuration type indicates whether the IP address is statically configured or dynamically assigned via DHCP. * @since_tizen 3.0 * @param[in] ap The access point handle * @param[in] address_family The address family @@ -2508,6 +2691,9 @@ int wifi_manager_ap_set_ip_config_type(wifi_manager_ap_h ap, /** * @brief Gets the IP address. + * @details This function retrieves the IP address for the specified address family. + * The IP address is the unique identifier assigned to a device on a network, + * allowing it to communicate with other devices on the same network or across different networks. * @since_tizen 3.0 * @remarks You must release @a ip_address using free(). * @param[in] ap The access point handle @@ -2530,6 +2716,8 @@ int wifi_manager_ap_get_ip_address(wifi_manager_ap_h ap, /** * @brief Sets the IP address. + * @details This function sets the IP address for the specified address family. + * If the IP address is set to NULL, the existing IP address for that address family will be deleted. * @since_tizen 3.0 * @param[in] ap The access point handle * @param[in] address_family The address family @@ -2549,6 +2737,9 @@ int wifi_manager_ap_set_ip_address(wifi_manager_ap_h ap, /** * @brief Called with an IPv6 address. + * @details This callback function type is used by the `wifi_manager_ap_foreach_ipv6_address()` function + * to iterate over each IPv6 address assigned to the Wi-Fi interface for the specified access point. + * The callback function receives the IPv6 address as a parameter and returns a boolean value indicating whether to continue iterating or to stop. * @since_tizen 4.0 * @remarks If @a ipv6_address is needed outside the callback, a copy should be * made. @a ipv6_address will be freed automatically after the execution @@ -2564,6 +2755,8 @@ typedef bool(*wifi_manager_ap_ipv6_address_cb)(char *ipv6_address, void *user_da /** * @brief Gets all IPv6 addresses assigned to the Wi-Fi interface. + * @details This function retrieves all IPv6 addresses assigned to the Wi-Fi interface for the specified access point. + * It uses a callback function to iterate over each IPv6 address and provide it to the caller. * @since_tizen 4.0 * @param[in] ap The access point handle * @param[in] callback The callback to be called for each IPv6 address @@ -2580,6 +2773,8 @@ int wifi_manager_ap_foreach_ipv6_address(wifi_manager_ap_h ap, /** * @brief Gets the subnet mask. + * @details This function retrieves the subnet mask for the specified address family. + * The subnet mask is used to determine which part of an IP address represents the network portion and which part represents the host portion. * @since_tizen 3.0 * @remarks You must release @a subnet_mask using free(). * @param[in] ap The access point handle @@ -2598,6 +2793,8 @@ int wifi_manager_ap_get_subnet_mask(wifi_manager_ap_h ap, /** * @brief Sets the subnet mask. + * @details This function sets the subnet mask for the specified address family. + * If the subnet mask is set to NULL, the existing subnet mask for that address family will be deleted. * @since_tizen 3.0 * @param[in] ap The access point handle * @param[in] address_family The address family @@ -2617,6 +2814,8 @@ int wifi_manager_ap_set_subnet_mask(wifi_manager_ap_h ap, /** * @brief Gets the gateway address. + * @details This function retrieves the gateway address for the specified address family. + * The gateway address is the IP address of the router or gateway that acts as the entry point to the wider internet or network. * @since_tizen 3.0 * @remarks You must release @a gateway_address using free(). * @param[in] ap The access point handle @@ -2635,6 +2834,8 @@ int wifi_manager_ap_get_gateway_address(wifi_manager_ap_h ap, /** * @brief Sets the gateway address. + * @details This function sets the gateway address for the specified address family. + * If the gateway address is set to NULL, the existing gateway address for that address family will be deleted. * @since_tizen 3.0 * @param[in] ap The access point handle * @param[in] address_family The address family @@ -2655,6 +2856,8 @@ int wifi_manager_ap_set_gateway_address(wifi_manager_ap_h ap, /** * @brief Gets the DHCP Server address. + * @details This function retrieves the DHCP server address for the specified address family. + * The DHCP server address is the IP address of the server that provides dynamic IP addresses to devices on the network. * @since_tizen 4.0 * @remarks You must release @a dhcp_server using g_free(). * This function is supported only for IPv4 address family. @@ -2673,6 +2876,8 @@ int wifi_manager_ap_get_dhcp_server_address(wifi_manager_ap_h ap, /** * @brief Gets the DHCP lease duration. + * @details This function retrieves the DHCP lease duration for the specified address family. + * The DHCP lease duration indicates the time period for which the IP address assigned to the device through DHCP will remain valid. * @since_tizen 4.0 * @param[in] ap The access point handle * @param[in] address_family The address family @@ -2688,6 +2893,8 @@ int wifi_manager_ap_get_dhcp_lease_duration(wifi_manager_ap_h ap, /** * @brief Gets the proxy address. + * @details This function retrieves the proxy address for the specified address family. + * The retrieved proxy address can be used to configure the proxy settings for the network interface. * @since_tizen 3.0 * @remarks You must release @a proxy_address using free(). * @param[in] ap The access point handle @@ -2706,6 +2913,8 @@ int wifi_manager_ap_get_proxy_address(wifi_manager_ap_h ap, /** * @brief Sets the proxy address. + * @details This function sets the proxy address for the specified address family. + * If the proxy address is set to NULL, the existing proxy address for that address family will be deleted. * @since_tizen 3.0 * @param[in] ap The access point handle * @param[in] address_family The address family @@ -2726,6 +2935,8 @@ int wifi_manager_ap_set_proxy_address(wifi_manager_ap_h ap, /** * @brief Gets the Proxy type. + * @details This function retrieves the proxy address type for the access point. + * The proxy type indicates whether the proxy settings are disabled, set to automatic, or set to manual. * @since_tizen 3.0 * @param[in] ap The access point handle * @param[out] proxy_type The type of proxy @@ -2759,6 +2970,8 @@ int wifi_manager_ap_set_proxy_type(wifi_manager_ap_h ap, /** * @brief Gets the DNS address. + * @details This function retrieves the DNS address for the specified order and address family. + * Up to two DNS addresses can be retrieved for each address family. * @since_tizen 3.0 * @remarks The allowance of DNS address is @c 2.You must release @a dns_address using free(). * @param[in] ap The access point handle @@ -2778,6 +2991,9 @@ int wifi_manager_ap_get_dns_address(wifi_manager_ap_h ap, /** * @brief Sets the DNS address. + * @details This function sets the DNS address for the specified order and address family. + * Up to two DNS addresses can be set for each address family. + * If the DNS address is set to NULL, the existing DNS address for that order and address family will be deleted. * @since_tizen 3.0 * @remarks The allowance of DNS address is @c 2 \n * @param[in] ap The access point handle @@ -2801,6 +3017,8 @@ int wifi_manager_ap_set_dns_address(wifi_manager_ap_h ap, /** * @brief Gets the DNS config type. + * @details This function retrieves the DNS configuration type for the specified address family. + * The DNS configuration type indicates how the DNS server addresses are configured for the network interface. * @since_tizen 4.0 * @param[in] ap The access point handle * @param[in] address_family The address family @@ -2817,6 +3035,8 @@ int wifi_manager_ap_get_dns_config_type(wifi_manager_ap_h ap, /** * @brief Sets the DNS config type. + * @details This function sets the DNS configuration type for the specified address family. + * The DNS configuration type determines how the DNS server addresses are configured for the network interface. * @since_tizen 4.0 * @param[in] ap The access point handle * @param[in] address_family The address family @@ -2834,6 +3054,9 @@ int wifi_manager_ap_set_dns_config_type(wifi_manager_ap_h ap, /** * @brief Gets the network prefix length. + * @details This function retrieves the network prefix length for the specified address family. + * The network prefix length defines the subnet mask for the network interface, + * determining the range of IP addresses available for devices connected to the network. * @since_tizen 4.0 * @param[in] ap The access point handle * @param[in] address_family The address family @@ -2851,6 +3074,9 @@ int wifi_manager_ap_get_prefix_length(wifi_manager_ap_h ap, /** * @brief Sets the network prefix length. + * @details This function sets the network prefix length for the specified address family. + * The network prefix length is used to define the subnet mask for the network interface, + * which determines the range of IP addresses available for devices connected to the network. * @since_tizen 4.0 * @param[in] ap The access point handle * @param[in] address_family The address family @@ -2869,6 +3095,8 @@ int wifi_manager_ap_set_prefix_length(wifi_manager_ap_h ap, /** * @brief Gets the Wi-Fi disconnect reason from the supplicant. + * @details This function retrieves the Wi-Fi disconnect reason from the supplicant. + * The disconnect reason provides detailed information about the cause of the disconnection between the device and the access point. * @since_tizen 3.0 * @param[in] ap The access point handle * @param[out] disconnect_reason The supplicant disconnect reason @@ -2884,6 +3112,8 @@ int wifi_manager_ap_get_disconnect_reason(wifi_manager_ap_h ap, /** * @brief Gets the error state. + * @details This function retrieves the Wi-Fi connection error state for the access point. + * The error state indicates any issues encountered during the connection process to the access point. * @since_tizen 4.0 * @param[in] ap The access point handle * @param[out] error_state The Wi-Fi connection error state @@ -2898,6 +3128,8 @@ int wifi_manager_ap_get_error_state(wifi_manager_ap_h ap, wifi_manager_error_e * /** * @brief Gets the Wi-Fi Association Status Code from the supplicant. + * @details This function retrieves the Wi-Fi Association Status Code from the supplicant. + * The status code provides detailed information about the result of the association process between the device and the access point. * @since_tizen 5.0 * @param[in] ap The access point handle * @param[out] status_code The supplicant Wi-Fi association status code @@ -2913,6 +3145,8 @@ int wifi_manager_ap_get_assoc_status_code(wifi_manager_ap_h ap, wifi_manager_assoc_status_code_e *status_code); /** * @brief Called with VSIE data and length of VSIE. + * @details This callback function type is used to iterate through the Vendor-Specific Information Element (VSIE) list. + * It is called once for each VSIE found, providing the VSIE data and its length. * @since_tizen 5.0 * @remarks If @a vsie is needed outside the callback, a copy should be * made. @a vsie will be freed automatically after the execution @@ -2929,6 +3163,8 @@ typedef bool(*wifi_manager_ap_vsie_cb)(unsigned char *vsie, int length, void *us /** * @brief Gets all VSIE of AP. + * @details This function retrieves all Vendor-Specific Information Elements (VSIE) associated with the access point. + * VSIE are custom elements added by vendors to provide additional information about the access point. * @since_tizen 5.0 * @param[in] ap The access point handle * @param[in] callback The callback to be called for each VSIE of AP @@ -2944,6 +3180,8 @@ int wifi_manager_ap_foreach_vsie(wifi_manager_ap_h ap, /** * @brief Gets the raw country code. + * @details This function retrieves the raw country code associated with the access point. + * The country code is a two-letter ISO 3166-1 alpha-2 country code that identifies the country where the access point is located. * @since_tizen 5.0 * @remarks You must release @a country_code using free(). * @param[in] ap The access point handle @@ -2959,6 +3197,9 @@ int wifi_manager_ap_get_countrycode(wifi_manager_ap_h ap, char **country_code); /** * @brief Called for each found BSSID. + * @details This callback function type is used to iterate through the found BSSID list. + * It is called once for each BSSID found, providing information about the BSSID, + * its signal strength (RSSI), and its operating frequency. * @since_tizen 5.0 * @remarks The @a bssid can be used only in the callback. To use it outside, make a copy. * @a bssid is managed by the platform and will be released after the execution @@ -2974,6 +3215,9 @@ typedef bool(*wifi_manager_found_bssid_cb)(const char *bssid, int rssi, int freq /** * @brief Gets the BSSID list. + * @details This function retrieves the BSSID list associated with the access point. + * Each BSSID represents a unique identifier for a wireless network interface, + * typically corresponding to a specific access point or router. * @since_tizen 5.0 * @param[in] ap The access point handle * @param[in] callback The callback to be called @@ -3000,6 +3244,8 @@ int wifi_manager_foreach_found_bssid(wifi_manager_ap_h ap, wifi_manager_found_bs /** * @brief Gets the Wi-Fi security mode. + * @details This function retrieves the Wi-Fi security mode for the access point. + * The security mode determines the level of protection provided to the Wi-Fi network against unauthorized access and attacks. * @since_tizen 3.0 * @param[in] ap The access point handle * @param[out] type The type of Wi-Fi security @@ -3030,6 +3276,8 @@ int wifi_manager_ap_is_security_type_supported(wifi_manager_ap_h ap, /** * @brief Sets the Wi-Fi security mode. + * @details This function sets the Wi-Fi security mode for the access point. + * The security mode determines the level of protection provided to the Wi-Fi network against unauthorized access and attacks. * @since_tizen 3.0 * @param[in] ap The access point handle * @param[in] type The type of Wi-Fi security @@ -3044,6 +3292,8 @@ int wifi_manager_ap_set_security_type(wifi_manager_ap_h ap, wifi_manager_securit /** * @brief Gets the Wi-Fi encryption type. + * @details This function retrieves the Wi-Fi encryption type for the access point. + * The encryption type determines how data transmitted over the Wi-Fi network is protected from unauthorized access. * @since_tizen 3.0 * @param[in] ap The access point handle * @param[out] type The type of Wi-Fi encryption @@ -3058,6 +3308,8 @@ int wifi_manager_ap_get_encryption_type(wifi_manager_ap_h ap, wifi_manager_encry /** * @brief Sets the Wi-Fi encryption type. + * @details This function sets the Wi-Fi encryption type for the access point. + * The encryption type determines how data transmitted over the Wi-Fi network is protected from unauthorized access. * @since_tizen 3.0 * @param[in] ap The access point handle * @param[in] type The type of Wi-Fi encryption @@ -3072,6 +3324,8 @@ int wifi_manager_ap_set_encryption_type(wifi_manager_ap_h ap, wifi_manager_encry /** * @brief Checks whether the passphrase is required or not. + * @details This function checks whether a passphrase is required for the access point. + * A passphrase is necessary to authenticate and establish a secure connection with the access point. * @since_tizen 3.0 * @remarks This function is not valid if security type is #WIFI_MANAGER_SECURITY_TYPE_EAP. * @param[in] ap The access point handle @@ -3087,7 +3341,9 @@ int wifi_manager_ap_set_encryption_type(wifi_manager_ap_h ap, wifi_manager_encry int wifi_manager_ap_is_passphrase_required(wifi_manager_ap_h ap, bool *required); /** - * @brief Sets the passphrase. + * @brief sets the passphrase for a Wi-Fi access point + * @details This function sets the passphrase for a Wi-Fi access point. + * The passphrase is used to authenticate and establish a secure connection with the access point. * @since_tizen 3.0 * @param[in] ap The access point handle * @param[in] passphrase The passphrase of access point @@ -3102,6 +3358,9 @@ int wifi_manager_ap_set_passphrase(wifi_manager_ap_h ap, const char *passphrase) /** * @brief Checks whether the WPS(Wi-Fi Protected Setup) is supported or not. + * @details This function checks whether WPS is supported by the access point. + * WPS is a standard that simplifies the process of setting up secure Wi-Fi connections + * by allowing devices to connect to each other without entering passwords manually. * @since_tizen 3.0 * @param[in] ap The access point handle * @param[out] supported @c true if WPS is supported, @@ -3119,6 +3378,9 @@ int wifi_manager_ap_is_wps_supported(wifi_manager_ap_h ap, bool *supported); /** * @brief Checks whether Protected Management Frame is required. + * @details This function checks whether PMF is required for the access point. + * PMF is a security feature that protects wireless networks from various types of attacks, + * such as deauthentication and disassociation attacks. * @since_tizen 7.0 * @param[in] ap The access point handle * @param[out] required true when required and false when not required @@ -3161,6 +3423,8 @@ int wifi_manager_ap_set_eap_passphrase(wifi_manager_ap_h ap, const char *user_na /** * @brief Gets the passphrase of EAP. + * @details This function retrieves the user name and password status used for EAP authentication. + * It is only valid if the EAP type is set to #WIFI_MANAGER_EAP_TYPE_PEAP or #WIFI_MANAGER_EAP_TYPE_TTLS. * @since_tizen 3.0 * @remarks This function is valid only if the EAP type is #WIFI_MANAGER_EAP_TYPE_PEAP or #WIFI_MANAGER_EAP_TYPE_TTLS. * You must release @a user_name using free(). @@ -3180,6 +3444,8 @@ int wifi_manager_ap_get_eap_passphrase(wifi_manager_ap_h ap, char **user_name, b /** * @brief Sets access point anonymous identity. + * @details This function sets the anonymous identity for EAP authentication. + * The anonymous identity is an optional field that can be used to provide additional information about the client during the EAP authentication process. * @since_tizen 5.5 * @param[in] ap The access point handle * @param[in] anonymous_identity The anonymous identity @@ -3193,6 +3459,8 @@ int wifi_manager_ap_set_eap_anonymous_identity(wifi_manager_ap_h ap, const char /** * @brief Gets access point anonymous identity. + * @details This function retrieves the anonymous identity used for EAP authentication. + * The anonymous identity is an optional field that can be used to provide additional information about the client during the EAP authentication process. * @since_tizen 5.5 * @remarks You must release @a anonymous_identity using free(). * @param[in] ap The access point handle @@ -3208,6 +3476,8 @@ int wifi_manager_ap_get_eap_anonymous_identity(wifi_manager_ap_h ap, char **anon /** * @brief Gets the CA Certificate of EAP. + * @details This function retrieves the file path of the CA certificate used for EAP authentication. + * It is only valid if the EAP type is set to #WIFI_MANAGER_EAP_TYPE_TLS. * @since_tizen 3.0 * @remarks This function is valid only if the EAP type is #WIFI_MANAGER_EAP_TYPE_TLS. * You must release @a file using free(). @@ -3225,6 +3495,9 @@ int wifi_manager_ap_get_eap_ca_cert_file(wifi_manager_ap_h ap, char **file); /** * @brief Sets the CA Certificate of EAP. + * @details This function sets the CA certificate for EAP authentication. + * It is only valid if the EAP type is set to #WIFI_MANAGER_EAP_TYPE_TLS. + * The CA certificate is used to verify the server's identity during the EAP authentication process. * @since_tizen 3.0 * @remarks This function is valid only if the EAP type is #WIFI_MANAGER_EAP_TYPE_TLS. * @param[in] ap The access point handle @@ -3240,6 +3513,8 @@ int wifi_manager_ap_set_eap_ca_cert_file(wifi_manager_ap_h ap, const char *file) /** * @brief Gets the Client Certificate of EAP. + * @details This function retrieves the file path of the client certificate used for EAP authentication. + * It is only valid if the EAP type is set to #WIFI_MANAGER_EAP_TYPE_TLS. * @since_tizen 3.0 * @remarks This function is valid only if the EAP type is #WIFI_MANAGER_EAP_TYPE_TLS. * You must release @a file using free(). @@ -3257,6 +3532,9 @@ int wifi_manager_ap_get_eap_client_cert_file(wifi_manager_ap_h ap, char **file); /** * @brief Sets the Client Certificate of EAP. + * @details This function sets the client certificate for EAP authentication. + * It is only valid if the EAP type is set to #WIFI_MANAGER_EAP_TYPE_TLS. + * The client certificate is used to verify the client's identity during the EAP authentication process. * @since_tizen 3.0 * @remarks This function is valid only if the EAP type is #WIFI_MANAGER_EAP_TYPE_TLS. * @param[in] ap The access point handle @@ -3272,6 +3550,8 @@ int wifi_manager_ap_set_eap_client_cert_file(wifi_manager_ap_h ap, const char *f /** * @brief Gets the private key file of EAP. + * @details This function retrieves the file path of the private key used for EAP authentication. + * It is only valid if the EAP type is set to #WIFI_MANAGER_EAP_TYPE_TLS. * @since_tizen 3.0 * @remarks This function is valid only if the EAP type is #WIFI_MANAGER_EAP_TYPE_TLS. * You must release @a file using free(). @@ -3289,6 +3569,9 @@ int wifi_manager_ap_get_eap_private_key_file(wifi_manager_ap_h ap, char **file); /** * @brief Sets the private key information of EAP. + * @details This function sets the private key information for EAP authentication. + * It is only valid if the EAP type is set to #WIFI_MANAGER_EAP_TYPE_TLS. + * The private key information includes the file path of the private key and its corresponding password. * @since_tizen 3.0 * @remarks This function is valid only if the EAP type is #WIFI_MANAGER_EAP_TYPE_TLS. * @param[in] ap The access point handle @@ -3306,6 +3589,8 @@ int wifi_manager_ap_set_eap_private_key_info(wifi_manager_ap_h ap, /** * @brief Gets the EAP type of Wi-Fi. + * @details This function retrieves the EAP type set for the given Wi-Fi access point. + * The EAP type specifies the EAP method that should be used during the EAP authentication process. * @since_tizen 3.0 * @param[in] ap The access point handle * @param[out] type The type of EAP @@ -3321,6 +3606,8 @@ int wifi_manager_ap_get_eap_type(wifi_manager_ap_h ap, wifi_manager_eap_type_e * /** * @brief Sets the EAP type of Wi-Fi. + * @details This function sets the EAP type for the given Wi-Fi access point. + * The EAP type specifies the EAP method that should be used during the EAP authentication process. * @since_tizen 3.0 * @param[in] ap The access point handle * @param[in] type The type of EAP @@ -3335,6 +3622,8 @@ int wifi_manager_ap_set_eap_type(wifi_manager_ap_h ap, wifi_manager_eap_type_e t /** * @brief Gets the type of EAP phase2 authentication of Wi-Fi. + * @details This function retrieves the EAP Phase 2 authentication type set for the given Wi-Fi access point. + * The EAP Phase 2 authentication type specifies how the client should authenticate itself during the second phase of the EAP authentication process. * @since_tizen 3.0 * @param[in] ap The access point handle * @param[out] type The type of EAP phase2 authentication @@ -3350,6 +3639,8 @@ int wifi_manager_ap_get_eap_auth_type(wifi_manager_ap_h ap, wifi_manager_eap_aut /** * @brief Sets the type of EAP phase2 authentication of Wi-Fi. + * @details This function sets the EAP Phase 2 authentication type for the given Wi-Fi access point. + * The EAP Phase 2 authentication type specifies how the client should authenticate itself during the second phase of the EAP authentication process. * @since_tizen 3.0 * @param[in] ap The access point handle * @param[in] type The type of EAP phase2 authentication @@ -3373,6 +3664,8 @@ int wifi_manager_ap_set_eap_auth_type(wifi_manager_ap_h ap, wifi_manager_eap_aut /** * @brief Gets access point configuration handle. + * @details This function creates a new access point configuration handle with the provided parameters. + * The handle can be used to save or update the access point configuration. * @since_tizen 3.0 * @remarks You must release @a config using wifi_manager_config_destroy(). * @@ -3397,6 +3690,8 @@ int wifi_manager_config_create(wifi_manager_h wifi, const char *name, /** * @brief Clones the access point configuration handle. + * @details This function creates a copy of the given access point configuration handle. + * The new handle has the same properties as the original handle. * @since_tizen 3.0 * @remarks You must release @a cloned_config using wifi_manager_config_destroy(). * @@ -3416,6 +3711,8 @@ int wifi_manager_config_clone(wifi_manager_config_h origin, wifi_manager_config_ /** * @brief Destroys the access point configuration handle. + * @details This function destroys the access point configuration handle and releases all its associated resources. + * After calling this function, the handle is no longer valid. * @since_tizen 3.0 * * @param[in] config The access point configuration handle @@ -3455,6 +3752,8 @@ int wifi_manager_config_save(wifi_manager_h wifi, wifi_manager_config_h config); /** * @brief Removes Wi-Fi configuration of access point. + * @details This function deletes the specified access point configuration from the system. + * After this function is called, the access point configuration will no longer be available. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.profile @@ -3476,6 +3775,9 @@ int wifi_manager_config_remove(wifi_manager_h wifi, wifi_manager_config_h config /** * @brief Gets configurations of an access point. + * @details This function retrieves all access point configurations stored in the system. + * Each access point configuration is represented by a handle, + * which can be used to get detailed information about the access point. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.profile @@ -3499,6 +3801,8 @@ int wifi_manager_config_foreach_configuration(wifi_manager_h wifi, /** * @brief Gets the name of access point from configuration. + * @details This function retrieves the name set for the given access point configuration. + * The name is a user-friendly identifier for the access point. * @since_tizen 3.0 * @remarks You must release @a name using free(). * @@ -3517,6 +3821,8 @@ int wifi_manager_config_get_name(wifi_manager_config_h config, char **name); /** * @brief Gets the security type of access point from configuration. + * @details This function retrieves the security type set for the given access point configuration. + * The security type determines the type of security mechanism used to protect the wireless network. * @since_tizen 3.0 * * @param[in] config The access point configuration handle @@ -3534,6 +3840,8 @@ int wifi_manager_config_get_security_type(wifi_manager_config_h config, /** * @brief Sets access point proxy address configuration. + * @details This function sets the proxy address for the given access point configuration. + * The proxy address is used to route traffic through a proxy server. * @since_tizen 3.0 * * @param[in] config The access point configuration handle @@ -3555,6 +3863,8 @@ int wifi_manager_config_set_proxy_address(wifi_manager_config_h config, /** * @brief Gets the proxy address of access point from configuration. + * @details This function retrieves the proxy address set for the given access point configuration. + * The proxy address is used to route traffic through a proxy server. * @since_tizen 3.0 * @remarks You must release @a proxy_address using free(). * @@ -3575,6 +3885,8 @@ int wifi_manager_config_get_proxy_address(wifi_manager_config_h config, /** * @brief Sets the hidden property of access point from the configuration. + * @details This function sets the hidden property of the access point in the given access point configuration. + * The hidden property indicates whether the access point is hidden or not. * @since_tizen 3.0 * * @param[in] config The access point configuration handle @@ -3593,6 +3905,8 @@ int wifi_manager_config_set_hidden_ap_property(wifi_manager_config_h config, boo /** * @brief Gets the hidden property of access point from the configuration. + * @details This function retrieves the hidden property of the access point set in the given access point configuration. + * The hidden property indicates whether the access point is hidden or not. * @since_tizen 3.0 * * @param[in] config The access point configuration handle @@ -3609,6 +3923,8 @@ int wifi_manager_config_get_hidden_ap_property(wifi_manager_config_h config, boo /** * @brief Gets access point IP config type from configuration. + * @details This function retrieves the IP configuration type set for the given access point configuration. + * The IP configuration type determines how the IP address and related information (e.g., subnet mask, gateway) are obtained. * @since_tizen 5.0 * * @param[in] config The access point configuration handle @@ -3628,6 +3944,8 @@ int wifi_manager_config_get_ip_config_type(wifi_manager_config_h config, /** * @brief Sets access point IP config type to configuration. + * @details This function sets the IP configuration type for the given access point configuration. + * The IP configuration type determines how the IP address and related information (e.g., subnet mask, gateway) are obtained. * @since_tizen 5.0 * * @param[in] config The access point configuration handle @@ -3648,6 +3966,8 @@ int wifi_manager_config_set_ip_config_type(wifi_manager_config_h config, /** * @brief Gets access point IP address from configuration. + * @details This function retrieves the IP address set for the given access point configuration. + * The IP address is used as the local address for the device when connected to the access point. * @since_tizen 5.0 * @remarks You must release @a ip_address using free(). * @@ -3668,6 +3988,8 @@ int wifi_manager_config_get_ip_address(wifi_manager_config_h config, /** * @brief Sets access point IP address to configuration. + * @details This function sets the IP address for the given access point configuration. + * The IP address is used as the local address for the device when connected to the access point. * @since_tizen 5.0 * * @param[in] config The access point configuration handle @@ -3688,6 +4010,8 @@ int wifi_manager_config_set_ip_address(wifi_manager_config_h config, /** * @brief Gets access point subnet mask from configuration. + * @details This function retrieves the subnet mask set for the given access point configuration. + * The subnet mask is used to specify the network portion of an IP address. * @since_tizen 5.0 * @remarks You must release @a subnet_mask using free(). * @@ -3708,6 +4032,8 @@ int wifi_manager_config_get_subnet_mask(wifi_manager_config_h config, /** * @brief Sets access point subnet mask to configuration. + * @details This function sets the subnet mask for the given access point configuration. + * The subnet mask is used to specify the network portion of an IP address. * @since_tizen 5.0 * * @param[in] config The access point configuration handle @@ -3728,6 +4054,8 @@ int wifi_manager_config_set_subnet_mask(wifi_manager_config_h config, /** * @brief Gets the network prefix length from configuration. + * @details This function retrieves the network prefix length set for the given access point configuration. + * The network prefix length specifies the number of leading bits in the IP address that are used to determine the network portion of the address. * @since_tizen 5.0 * * @param[in] config The access point configuration handle @@ -3749,6 +4077,8 @@ int wifi_manager_config_get_prefix_length(wifi_manager_config_h config, /** * @brief Sets the network prefix length to configuration. + * @details This function sets the network prefix length for the given access point configuration. + * The network prefix length specifies the number of leading bits in the IP address that are used to determine the network portion of the address. * @since_tizen 5.0 * * @param[in] config The access point configuration handle @@ -3770,6 +4100,8 @@ int wifi_manager_config_set_prefix_length(wifi_manager_config_h config, /** * @brief Gets access point gateway address from configuration. + * @details This function retrieves the gateway address set for the given access point configuration. + * The gateway address is used as the default route for the network traffic. * @since_tizen 5.0 * @remarks You must release @a gateway_address using free(). * @@ -3790,6 +4122,8 @@ int wifi_manager_config_get_gateway_address(wifi_manager_config_h config, /** * @brief Sets access point gateway address to configuration. + * @details This function sets the gateway address for the given access point configuration. + * The gateway address is used as the default route for the network traffic. * @since_tizen 5.0 * * @param[in] config The access point configuration handle @@ -3811,6 +4145,8 @@ int wifi_manager_config_set_gateway_address(wifi_manager_config_h config, /** * @brief Gets access point dns config type from configuration. + * @details This function retrieves the DNS configuration type set for the given access point configuration. + * The DNS configuration type specifies how the DNS addresses are configured for the access point. * @since_tizen 5.0 * * @param[in] config The access point configuration handle @@ -3830,6 +4166,8 @@ int wifi_manager_config_get_dns_config_type(wifi_manager_config_h config, /** * @brief Sets access point dns config type to configuration. + * @details This function sets the DNS configuration type for the given access point configuration. + * The DNS configuration type specifies how the DNS addresses are configured for the access point. * @since_tizen 5.0 * * @param[in] config The access point configuration handle @@ -3850,6 +4188,8 @@ int wifi_manager_config_set_dns_config_type(wifi_manager_config_h config, /** * @brief Gets access point dns address from configuration. + * @details This function retrieves the DNS address set for the given access point configuration. + * The DNS address is used to resolve domain names to IP addresses during the network communication process. * @since_tizen 5.0 * @remarks The allowance of DNS address is @c 2.You must release @a dns_address using free(). * @@ -3872,6 +4212,8 @@ int wifi_manager_config_get_dns_address(wifi_manager_config_h config, /** * @brief Sets access point dns address to configuration. + * @details This function sets the DNS address for the given access point configuration. + * The DNS address is used to resolve domain names to IP addresses during the network communication process. * @since_tizen 5.0 * * @param[in] config The access point configuration handle @@ -3895,6 +4237,8 @@ int wifi_manager_config_set_dns_address(wifi_manager_config_h config, /** * @brief Gets access point anonymous identity from configuration. + * @details This function retrieves the anonymous identity set for the given access point configuration. + * The anonymous identity is used during the authentication process to identify the client anonymously when connecting to the access point. * @since_tizen 3.0 * @remarks You must release @a anonymous_identity using free(). * @@ -3911,6 +4255,8 @@ int wifi_manager_config_get_eap_anonymous_identity(wifi_manager_config_h config, /** * @brief Sets access point anonymous identity to configuration. + * @details This function sets the anonymous identity for the given access point configuration. + * The anonymous identity is used during the authentication process to identify the client anonymously when connecting to the access point. * @since_tizen 3.0 * * @param[in] config The access point configuration handle @@ -3928,6 +4274,8 @@ int wifi_manager_config_set_eap_anonymous_identity(wifi_manager_config_h config, /** * @brief Gets access point cacert file from configuration. + * @details This function retrieves the CA certificate file path set for the given access point configuration. + * The CA certificate file contains the trusted root certificates used to verify the server's certificate during the authentication process. * @since_tizen 3.0 * @remarks You must release @a ca_cert using free(). * @remarks The mediastorage privilege %http://tizen.org/privilege/mediastorage is needed \n @@ -3947,6 +4295,8 @@ int wifi_manager_config_get_eap_ca_cert_file(wifi_manager_config_h config, char /** * @brief Sets access point cacert file to configuration. + * @details This function sets the CA certificate file required for EAP authentication. + * The CA certificate file contains the trusted root certificates used to verify the server's certificate during the authentication process. * @since_tizen 3.0 * @remarks The mediastorage privilege %http://tizen.org/privilege/mediastorage is needed \n * if @a ca_cert is relevant to media storage.\n @@ -3967,6 +4317,8 @@ int wifi_manager_config_set_eap_ca_cert_file(wifi_manager_config_h config, const /** * @brief Gets access point client cert file from configuration. + * @details This function retrieves the client certificate file path set for the given access point configuration. + * The client certificate file is used for EAP authentication to establish a secure connection with the access point. * @since_tizen 3.0 * @remarks You must release @a client_cert using free(). * @@ -3982,6 +4334,8 @@ int wifi_manager_config_get_eap_client_cert_file(wifi_manager_config_h config, c /** * @brief Sets access point client cert file to configuration. + * @details This function sets the client certificate and private key files required for EAP authentication. + * These files are used to establish a secure connection with the access point. * @since_tizen 3.0 * * @param[in] config The access point configuration handle @@ -4000,6 +4354,8 @@ int wifi_manager_config_set_eap_client_cert_file(wifi_manager_config_h config, /** * @brief Gets the private key file of EAP. + * @details This function retrieves the file path of the private key used for EAP-TLS authentication. + * This function is only valid if the EAP type is set to #WIFI_MANAGER_EAP_TYPE_TLS. * @since_tizen 5.0 * @remarks This function is valid only if the EAP type is #WIFI_MANAGER_EAP_TYPE_TLS. * You must release @a file using free(). @@ -4018,6 +4374,9 @@ int wifi_manager_config_get_eap_private_key_file(wifi_manager_config_h config, c /** * @brief Sets the private key information of EAP. + * @details This function sets the private key information required for EAP-TLS authentication. + * It includes the file path of the private key and its corresponding password. + * This function is only valid if the EAP type is set to #WIFI_MANAGER_EAP_TYPE_TLS. * @since_tizen 5.0 * @remarks This function is valid only if the EAP type is #WIFI_MANAGER_EAP_TYPE_TLS. * @@ -4037,6 +4396,8 @@ int wifi_manager_config_set_eap_private_key_info(wifi_manager_config_h config, /** * @brief Gets access point identity from configuration. + * @details This function retrieves the EAP identity set for the given access point configuration. + * The EAP identity is used during the authentication process to identify the client when connecting to the access point. * @since_tizen 3.0 * @remarks You must release @a identity using free(). * @@ -4052,6 +4413,8 @@ int wifi_manager_config_get_eap_identity(wifi_manager_config_h config, char **id /** * @brief Sets access point identity to configuration. + * @details This function sets the EAP identity for the given access point configuration. + * The EAP identity is used during the authentication process to identify the client when connecting to the access point. * @since_tizen 3.0 * * @param[in] config The access point configuration handle @@ -4068,6 +4431,8 @@ int wifi_manager_config_set_eap_identity(wifi_manager_config_h config, const cha /** * @brief Gets access point EAP type from configuration. + * @details This function retrieves the EAP type set for the given access point configuration. + * The EAP type specifies the EAP protocol used to authenticate the client when connecting to the access point. * @since_tizen 3.0 * * @param[in] config The access point configuration handle @@ -4082,6 +4447,8 @@ int wifi_manager_config_get_eap_type(wifi_manager_config_h config, wifi_manager_ /** * @brief Sets access point EAP type to configuration. + * @details This function sets the EAP type for the given access point configuration. + * The EAP type specifies the EAP protocol used to authenticate the client when connecting to the access point. * @since_tizen 3.0 * * @param[in] config The access point configuration handle @@ -4098,6 +4465,8 @@ int wifi_manager_config_set_eap_type(wifi_manager_config_h config, wifi_manager_ /** * @brief Gets access point EAP auth type from configuration. + * @details This function retrieves the EAP authentication type set for the given access point configuration. + * The EAP authentication type specifies the method used to authenticate the client when connecting to the access point. * @since_tizen 3.0 * * @param[in] config The access point configuration handle @@ -4113,6 +4482,8 @@ int wifi_manager_config_get_eap_auth_type(wifi_manager_config_h config, /** * @brief Sets access point EAP auth type to configuration. + * @details This function sets the EAP authentication type for the given access point configuration. + * The EAP authentication type specifies the method used to authenticate the client when connecting to the access point. * @since_tizen 3.0 * * @param[in] config The access point configuration handle @@ -4130,6 +4501,8 @@ int wifi_manager_config_set_eap_auth_type(wifi_manager_config_h config, /** * @brief Gets access point subject match from configuration. + * @details This function retrieves the EAP subject match set for the given access point configuration. + * The EAP subject match specifies which certificates to trust when connecting to the access point. * @since_tizen 3.0 * @remarks You must release @a subject_match using free(). * @@ -4146,6 +4519,8 @@ int wifi_manager_config_get_eap_subject_match(wifi_manager_config_h config, /** * @brief Sets access point subject match to configuration. + * @details This function sets the EAP subject match for the given access point configuration. + * The EAP subject match is used to specify which certificates to trust when connecting to the access point. * @since_tizen 3.0 * * @param[in] config The access point configuration handle @@ -4171,6 +4546,8 @@ int wifi_manager_config_set_eap_subject_match(wifi_manager_config_h config, /** * @brief Registers the callback called when a TDLS device is found. + * @details This function registers a callback function to receive notifications about discovered TDLS (802.11z) devices. + * When a TDLS device is found, the provided callback function will be called with the device information as an argument. * @since_tizen 4.0 * * @param[in] wifi The Wi-Fi handle @@ -4189,6 +4566,8 @@ int wifi_manager_tdls_set_discovered_cb(wifi_manager_h wifi, /** * @brief Unregisters the callback called when TDLS device is found. + * @details This function unregisters the callback that was previously registered using wifi_manager_tdls_set_discovered_cb(). + * After calling this function, the application will no longer receive notifications about discovered TDLS devices. * @since_tizen 4.0 * * @param[in] wifi The Wi-Fi handle @@ -4202,6 +4581,8 @@ int wifi_manager_tdls_unset_discovered_cb(wifi_manager_h wifi); /** * @brief Discovers devices that support TDLS. + * @details This function initiates a discovery process to find TDLS (802.11z)-capable devices within range. + * The MAC address of the peer device to be discovered can be optionally provided as an argument. * @since_tizen 4.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.set @@ -4221,6 +4602,8 @@ int wifi_manager_tdls_start_discovery(wifi_manager_h wifi, const char *peer_mac_ /** * @brief Connects to a peer device. + * @details This function establishes a TDLS (802.11z) connection with the specified peer device. + * The MAC address of the peer device to be connected must be provided as an argument. * @since_tizen 4.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.set @@ -4241,6 +4624,8 @@ int wifi_manager_tdls_connect(wifi_manager_h wifi, const char *peer_mac_addr); /** * @brief Disconnects the connected peer. + * @details This function disconnects the currently connected TDLS (802.11z) peer. + * The MAC address of the peer to be disconnected must be provided as an argument. * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.set @@ -4261,6 +4646,8 @@ int wifi_manager_tdls_disconnect(wifi_manager_h wifi, const char *peer_mac_addr) /** * @brief Gets Peer Mac address of Connected peer. + * @details This function retrieves the MAC address of the currently connected TDLS (802.11z) peer. + * The MAC address is returned as a null-terminated string and must be freed by the caller after use * @since_tizen 3.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.get @@ -4283,6 +4670,8 @@ int wifi_manager_tdls_get_connected_peer(wifi_manager_h wifi, char **peer_mac_ad /** * @brief Registers the callback called when TDLS state is changed. + * @details This function registers a callback function to receive notifications about changes in the TDLS (802.11z) state. + * When the TDLS state changes, the provided callback function will be called with the new state as an argument. * @since_tizen 3.0 * * @param[in] wifi The Wi-Fi handle @@ -4301,6 +4690,8 @@ int wifi_manager_tdls_set_state_changed_cb(wifi_manager_h wifi, /** * @brief Unregisters the callback called when TDLS state is changed. + * @details This function unregisters the callback that was previously registered using wifi_manager_tdls_set_state_changed_cb(). + * After calling this function, the application will no longer receive notifications about changes in the TDLS state. * @since_tizen 3.0 * * @param[in] wifi The Wi-Fi handle @@ -4316,6 +4707,8 @@ int wifi_manager_tdls_unset_state_changed_cb(wifi_manager_h wifi); /** * @brief Enables a TDLS channel switching request. + * @details This function enables the TDLS (802.11z) channel switching request for the specified TDLS peer. + * Channel switching allows the two peers to switch to a different channel to improve communication performance. * @since_tizen 4.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.set @@ -4339,6 +4732,8 @@ int wifi_manager_tdls_enable_channel_switching(wifi_manager_h wifi, /** * @brief Disables a TDLS channel switching request. + * @details This function disables the TDLS (802.11z) channel switching request for the specified TDLS peer. + * Channel switching allows the two peers to switch to a different channel to improve communication performance. * @since_tizen 4.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.set @@ -4361,6 +4756,8 @@ int wifi_manager_tdls_disable_channel_switching(wifi_manager_h wifi, /** * @brief Registers the callback called when IP conflict state is changed. + * @details This function registers a callback function to receive notifications about changes in the IP conflict state. + * When the IP conflict state changes, the provided callback function will be called with the new state as an argument. * @since_tizen 5.0 * @param[in] wifi The Wi-Fi handle * @param[in] callback The callback function to be called @@ -4377,6 +4774,8 @@ int wifi_manager_set_ip_conflict_cb(wifi_manager_h wifi, /** * @brief Unregisters the callback called when IP conflict state is changed. + * @details This function unregisters the callback that was previously registered using wifi_manager_set_ip_conflict_cb(). + * After calling this function, the application will no longer receive notifications about changes in the IP conflict state. * @since_tizen 5.0 * @param[in] wifi The Wi-Fi handle * @return 0 on success, otherwise negative error value @@ -4390,6 +4789,8 @@ int wifi_manager_unset_ip_conflict_cb(wifi_manager_h wifi); /** * @brief Enables or disables IP conflict detection. + * @details This function enables or disables the IP conflict detection feature on the device. When enabled, + * the device periodically checks for IP address conflicts with other devices on the same network. * @since_tizen 5.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.set @@ -4410,6 +4811,9 @@ int wifi_manager_set_ip_conflict_detect_enable(wifi_manager_h wifi, /** * @brief Checks whether IP conflict detection is enabled. + * @details This function checks if the IP conflict detection feature is enabled on the device. + * If the feature is enabled, the function sets the @a state parameter to @c true; + * otherwise, it sets it to @c false. * @since_tizen 5.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.get @@ -4428,6 +4832,9 @@ int wifi_manager_ip_conflict_detect_is_enabled(wifi_manager_h wifi, bool *state) /** * @brief Gets the state of the IP conflict. + * @details This function retrieves the current state of the IP conflict detection feature. + * The IP conflict state indicates whether there is an IP address conflict + * with other devices on the same network. * @since_tizen 5.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.get @@ -4446,6 +4853,9 @@ int wifi_manager_get_ip_conflict_state(wifi_manager_h wifi, /** * @brief Gets whether 5Ghz Wi-Fi band is supported. + * @details This function checks if the device supports the 5Ghz Wi-Fi band. + * If the device supports it, the function sets the @a supported parameter to @c true; + * otherwise, it sets it to @c false. * @since_tizen 5.5 * @privlevel public * @privilege %http://tizen.org/privilege/network.get @@ -4464,6 +4874,9 @@ int wifi_manager_is_5ghz_band_supported(wifi_manager_h wifi, bool *supported); /** * @brief Gets whether 6Ghz Wi-Fi band is supported. + * @details This function checks if the device supports the 6Ghz Wi-Fi band. + * If the device supports it, the function sets the @a supported parameter to @c true; + * otherwise, it sets it to @c false. * @since_tizen 8.0 * @privlevel public * @privilege %http://tizen.org/privilege/network.get