Correct doxygen 13/159113/1 accepted/tizen/unified/20171115.061143 submit/tizen/20171108.071810 submit/tizen/20171113.231943
authorchleun.moon <chleun.moon@samsung.com>
Thu, 26 Jan 2017 06:23:23 +0000 (15:23 +0900)
committerSeonah Moon <seonah1.moon@samsung.com>
Tue, 7 Nov 2017 04:45:44 +0000 (13:45 +0900)
Change-Id: I50b5d838308316cd5415bc3628ad35354424e7f1
Signed-off-by: Seonah Moon <seonah1.moon@samsung.com>
doc/wifi_doc.h

index 344d4c990540fe82554f78b11ea7e9624e7325da..ae737b1c880a3a27662316836f601147d62885fa 100755 (executable)
@@ -24,7 +24,7 @@
  * @defgroup CAPI_NETWORK_WIFI_MODULE Wi-Fi (Deprecated)
  * @brief The Wi-Fi API provides functions for managing Wi-Fi and monitoring the state of Wi-Fi.
  * @section CAPI_NETWORK_WIFI_MODULE_HEADER Required Header
- *   \#include <wifi.h>
+ * \#include <wifi.h>
  *
  * @section CAPI_NETWORK_WIFI_MODULE_OVERVIEW Overview
  * Wi-Fi allows your application to connect to a Wireless Local Area Network (WLAN) and to transfer data over the network.
@@ -34,8 +34,8 @@
  * @section CAPI_NETWORK_WIFI_MODULE_FEATURE Related Features
  * This API is related with the following features:\n
  * - http://tizen.org/feature/network.wifi\n
- * It is recommended to design feature related codes in your application for reliability.\n
- * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
+ * It is recommended to design applications with regard to features, for reliability.\n
+ * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, and control your application's actions accordingly.\n
  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature List</b>.</a>
  */
  * @defgroup CAPI_NETWORK_WIFI_MANAGEMENT_MODULE Wi-Fi Management
  * @brief The Wi-Fi API provides functions for managing Wi-Fi.
  * @section CAPI_NETWORK_WIFI_MANAGEMENT_MODULE_HEADER Required Header
- *   \#include <wifi.h>
+ * \#include <wifi.h>
  *
  * @section CAPI_NETWORK_WIFI_MANAGEMENT_MODULE_OVERVEW Overview
  * The Wi-Fi Manager provides functions 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
- * - Scans the access points
+ * - Activate / Deactivate the Wi-Fi device.
+ * - Connect to the access point.
+ * - Scans the access points.
  *
  * @section CAPI_NETWORK_WIFI_MANAGEMENT_MODULE_FEATURE Related Features
  * This API is related with the following features:\n
  * - http://tizen.org/feature/network.wifi\n
- * It is recommended to design feature related codes in your application for reliability.\n
- * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
+ * It is recommended to design applications with regard to features, for reliability.\n
+ * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, and control your application's actions accordingly.\n
  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature List</b>.</a>
  */
@@ -70,7 +70,7 @@
  * @defgroup CAPI_NETWORK_WIFI_MONITOR_MODULE Wi-Fi Monitor
  * @brief The Wi-Fi API provides functions for monitoring the state of Wi-Fi.
  * @section CAPI_NETWORK_WIFI_MONITOR_MODULE_HEADER Required Header
- *   \#include <wifi.h>
+ * \#include <wifi.h>
  *
  * @section CAPI_NETWORK_WIFI_MONITOR_MODULE_OVERVIEW Overview
  * The Wi-Fi Monitor allows monitoring the changes of Wi-Fi.
  * @section CAPI_NETWORK_WIFI_MONITOR_MODULE_FEATURE Related Features
  * This API is related with the following features:\n
  * - http://tizen.org/feature/network.wifi\n
- * It is recommended to design feature related codes in your application for reliability.\n
- * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
+ * It is recommended to design applications with regard to features, for reliability.\n
+ * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, and control your application's actions accordingly.\n
  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature List</b>.</a>
  */
 
 
 /**
- * @ingroup CAPI_NETWORK_WIFI_MANAGER_MODULE
+ * @ingroup CAPI_NETWORK_WIFI_MANAGEMENT_MODULE
  * @defgroup CAPI_NETWORK_WIFI_AP_MODULE AP
  * @brief The Access Point API provides functions for managing the Access Point.
  * @section CAPI_NETWORK_WIFI_AP_MODULE Required Header
- *   \#include <wifi.h>
+ * \#include <wifi.h>
  *
  * @section CAPI_NETWORK_WIFI_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.
@@ -99,8 +99,8 @@
  * @section CAPI_NETWORK_WIFI_AP_MODULE_FEATURE Related Features
  * This API is related with the following features:\n
  * - http://tizen.org/feature/network.wifi\n
- * It is recommended to design feature related codes in your application for reliability.\n
- * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
+ * It is recommended to design applications with regard to features, for reliability.\n
+ * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, and control your application's actions accordingly.\n
  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature List</b>.</a>
  */
  * @ingroup CAPI_NETWORK_WIFI_AP_MODULE
  * @defgroup CAPI_NETWORK_WIFI_AP_NETWORK_MODULE Network Information
  * @brief The Connection Information API provides functions for managing the network information.
- * @section CAPI_NETWORK_WIFI_AP_CONNECTION_MODULE  Required Header
- *   \#include <wifi.h>
+ * @section CAPI_NETWORK_WIFI_AP_CONNECTION_MODULE Required Header
+ * \#include <wifi.h>
  *
  * @section CAPI_NETWORK_WIFI_AP_CONNECTION_MODULE_OVERVIEW Overview
  * The Connection Information API provides functions for managing the network information. You can manage the network information using the functions.
  * @section CAPI_NETWORK_WIFI_AP_MODULE_FEATURE Related Features
  * This API is related with the following features:\n
  * - http://tizen.org/feature/network.wifi\n
- * It is recommended to design feature related codes in your application for reliability.\n
- * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
+ * It is recommended to design applications with regard to features, for reliability.\n
+ * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, and control your application's actions accordingly.\n
  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature List</b>.</a>
  */
  * @defgroup CAPI_NETWORK_WIFI_AP_SECURITY_MODULE Security Information
  * @brief The Security Information API provides functions for managing the Security information.
  * @section CAPI_NETWORK_WIFI_AP_SECURITY_MODULE Required Header
- *   \#include <wifi.h>
+ * \#include <wifi.h>
  *
  * @section CAPI_NETWORK_WIFI_AP_SECURITY_MODULE_OVERVIEW Overview
  * The Security Information API provides functions for managing the Security information. You can manage the Security information using the functions.
  * @section CAPI_NETWORK_WIFI_AP_SECURITY_MODULE_FEATURE Related Features
  * This API is related with the following features:\n
  * - http://tizen.org/feature/network.wifi\n
- * It is recommended to design feature related codes in your application for reliability.\n
- * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
+ * It is recommended to design applications with regard to features, for reliability.\n
+ * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, and control your application's actions accordingly.\n
  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature List</b>.</a>
  */
  * @defgroup CAPI_NETWORK_WIFI_AP_SECURITY_EAP_MODULE EAP
  * @brief The EAP API provides functions for managing the EAP information.
  * @section CAPI_NETWORK_WIFI_AP_SECURITY_EAP_MODULE Required Header
- *   \#include <wifi.h>
+ * \#include <wifi.h>
  *
  * @section CAPI_NETWORK_WIFI_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.
  * @section CAPI_NETWORK_WIFI_AP_SECURITY_EAP_MODULE_FEATURE Related Features
  * This API is related with the following features:\n
  * - http://tizen.org/feature/network.wifi\n
- * It is recommended to design feature related codes in your application for reliability.\n
- * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
+ * It is recommended to design applications with regard to features, for reliability.\n
+ * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, and control your application's actions accordingly.\n
  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature List</b>.</a>
  */
  * @defgroup CAPI_NETWORK_WIFI_CONFIG_MODULE Wi-Fi Configuration
  * @brief The Configuration API provides functions for managing the configuration of Wi-Fi.
  * @section CAPI_NETWORK_WIFI_CONFIG_MODULE Required Header
- *   \#include <wifi.h>
+ * \#include <wifi.h>
  *
  * @section CAPI_NETWORK_WIFI_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.
  * @section CAPI_NETWORK_WIFI_CONFIG_MODULE Related Features
  * This API is related with the following features:\n
  * - http://tizen.org/feature/network.wifi\n
- * It is recommended to design feature related codes in your application for reliability.\n
- * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
+ * It is recommended to design applications with regard to features, for reliability.\n
+ * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, and control your application's actions accordingly.\n
  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature List</b>.</a>
  */
 
 
 /**
- * @ingroup CAPI_NETWORK_WIFI_MANAGER_MODULE
- * @defgroup CAPI_NETWORK_WIFI_TDLS_MODULE TDLS
+ * @ingroup CAPI_NETWORK_WIFI_MODULE
+ * @defgroup CAPI_NETWORK_WIFI_TDLS_MODULE Wi-Fi TDLS
  * @brief The TDLS APIs for managing TDLS.
  * @section CAPI_NETWORK_WIFI_TDLS_MODULE Required Header
- *   \#include <wifi.h>
+ * \#include <wifi.h>
  *
  * @section CAPI_NETWORK_WIFI_TDLS_MODULE_OVERVIEW Overview
  * The TDLS APIs for managing TDLS.
- *
  * @section CAPI_NETWORK_WIFI_TDLS_MODULE Related Features
  * This API is related with the following features:\n
  * - http://tizen.org/feature/network.wifi.tdls\n
- * It is recommended to design feature related codes in your application for reliability.\n
- * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.
+ * It is recommended to design applications with regard to features, for reliability.\n
+ * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, and control your application's actions accordingly.
  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature List</b>.</a>
  */