Correct doxygen 77/112077/2 tizen_3.0_tv accepted/tizen/3.0/common/20170201.163934 accepted/tizen/3.0/ivi/20170201.035043 accepted/tizen/3.0/mobile/20170201.034942 accepted/tizen/3.0/tv/20170201.035011 accepted/tizen/3.0/wearable/20170201.035026 submit/tizen_3.0/20170126.063039
authorchleun.moon <chleun.moon@samsung.com>
Thu, 26 Jan 2017 01:22:52 +0000 (10:22 +0900)
committerchleun.moon <chleun.moon@samsung.com>
Thu, 26 Jan 2017 01:34:15 +0000 (10:34 +0900)
Change-Id: I635edcd6adf42d4759ed472d21768b2c3ba41cd0
Signed-off-by: cheoleun <chleun.moon@samsung.com>
doc/wifi_manager_doc.h

index c2bd50ce42d838436040c654c250ed0b710f288f..b2b0c87ab877b3881ee412e641d92d4ae1abe861 100755 (executable)
 #ifndef __TIZEN_NETWORK_WIFI_MANAGER_DOC_H__
 #define __TIZEN_NETWORK_WIFI_MANAGER_DOC_H__
 
+
 /**
- * @defgroup CAPI_NETWORK_WIFI_PACKAGE  Wi-Fi
  * @ingroup CAPI_NETWORK_FRAMEWORK
- *
+ * @defgroup CAPI_NETWORK_WIFI_PACKAGE Wi-Fi
  * @section CAPI_NETWORK_WIFI_MANAGER_MODULE_OVERVIEW Overview
  * Wi-Fi module will be substituted for Wi-Fi Manager module with handle based to support for multi instance.
  */
 
+
 /**
- * @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.
  * @ingroup CAPI_NETWORK_WIFI_PACKAGE
- *
+ * @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.
  * @section CAPI_NETWORK_WIFI_MANAGER_MODULE_HEADER Required Header
- *   \#include <wifi-manager.h>
+ * \#include <wifi-manager.h>
  *
  * @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.
+ *
  * @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
- *
  * 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 using features in your application can be found in the <a href="https://developer.tizen.org/development/getting-started/native-application/understanding-tizen-programming/application-filtering"><b>Feature List</b>.</a>
- *
  */
 
+
 /**
- * @defgroup CAPI_NETWORK_WIFI_MANAGER_MANAGEMENT_MODULE  Wi-Fi Management
- * @brief The Wi-Fi API provides functions for managing Wi-Fi.
  * @ingroup CAPI_NETWORK_WIFI_MANAGER_MODULE
- *
+ * @defgroup CAPI_NETWORK_WIFI_MANAGER_MANAGEMENT_MODULE Wi-Fi Management
+ * @brief The Wi-Fi API provides functions for managing Wi-Fi.
  * @section CAPI_NETWORK_WIFI_MANAGER_MANAGEMENT_MODULE_HEADER Required Header
- *   \#include <wifi-manager.h>
+ * \#include <wifi-manager.h>
  *
  * @section CAPI_NETWORK_WIFI_MANAGER_MANAGEMENT_MODULE_OVERVEW Overview
  * To use Wifi Manager API, first create a wifi handle using wifi_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.
  * 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_MANAGER_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 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 using features in your application can be found in the <a href="https://developer.tizen.org/development/getting-started/native-application/understanding-tizen-programming/application-filtering"><b>Feature List</b>.</a>
- *
  */
 
+
 /**
- * @defgroup CAPI_NETWORK_WIFI_MANAGER_MONITOR_MODULE  Wi-Fi Monitor
- * @brief The Wi-Fi API provides functions for monitoring the state of Wi-Fi.
  * @ingroup CAPI_NETWORK_WIFI_MANAGER_MODULE
- *
+ * @defgroup CAPI_NETWORK_WIFI_MANAGER_MONITOR_MODULE Wi-Fi Monitor
+ * @brief The Wi-Fi API provides functions for monitoring the state of Wi-Fi.
  * @section CAPI_NETWORK_WIFI_MANAGER_MONITOR_MODULE_HEADER Required Header
- *   \#include <wifi-manager.h>
+ * \#include <wifi-manager.h>
  *
  * @section CAPI_NETWORK_WIFI_MANAGER_MONITOR_MODULE_OVERVIEW Overview
  * The Wi-Fi Monitor allows monitoring the changes of Wi-Fi.
  * @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
- *
  * 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 using features in your application can be found in the <a href="https://developer.tizen.org/development/getting-started/native-application/understanding-tizen-programming/application-filtering"><b>Feature List</b>.</a>
- *
  */
 
+
 /**
- * @defgroup CAPI_NETWORK_WIFI_MANAGER_AP_MODULE  AP
- * @brief The Access Point API provides functions for managing the Access Point.
  * @ingroup CAPI_NETWORK_WIFI_MANAGER_MANAGEMENT_MODULE
- *
- * @section CAPI_NETWORK_WIFI_MANAGER_AP_MODULE  Required Header
- *   \#include <wifi-manager.h>
+ * @defgroup CAPI_NETWORK_WIFI_MANAGER_AP_MODULE AP
+ * @brief The Access Point API provides functions for managing the Access Point.
+ * @section CAPI_NETWORK_WIFI_MANAGER_AP_MODULE Required Header
+ * \#include <wifi-manager.h>
  *
  * @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.
  * @section CAPI_NETWORK_WIFI_MANAGER_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 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 using features in your application can be found in the <a href="https://developer.tizen.org/development/getting-started/native-application/understanding-tizen-programming/application-filtering"><b>Feature List</b>.</a>
- *
  */
 
+
 /**
- * @defgroup CAPI_NETWORK_WIFI_MANAGER_AP_NETWORK_MODULE  Network Information
- * @brief The Connection Information API provides functions for managing the network information.
  * @ingroup CAPI_NETWORK_WIFI_MANAGER_AP_MODULE
- *
- * @section CAPI_NETWORK_WIFI_MANAGER_AP_NETWORK_MODULE  Required Header
- *   \#include <wifi-manager.h>
+ * @defgroup CAPI_NETWORK_WIFI_MANAGER_AP_NETWORK_MODULE Network Information
+ * @brief The Connection Information API provides functions for managing the network information.
+ * @section CAPI_NETWORK_WIFI_MANAGER_AP_NETWORK_MODULE Required Header
+ * \#include <wifi-manager.h>
  *
  * @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.
  * @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
- *
  * 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 using features in your application can be found in the <a href="https://developer.tizen.org/development/getting-started/native-application/understanding-tizen-programming/application-filtering"><b>Feature List</b>.</a>
- *
  */
 
+
 /**
- * @defgroup CAPI_NETWORK_WIFI_MANAGER_AP_SECURITY_MODULE  Security Information
- * @brief The Security Information API provides functions for managing the Security information.
  * @ingroup CAPI_NETWORK_WIFI_MANAGER_AP_MODULE
- *
- * @section CAPI_NETWORK_WIFI_MANAGER_AP_SECURITY_MODULE  Required Header
- *   \#include <wifi-manager.h>
+ * @defgroup CAPI_NETWORK_WIFI_MANAGER_AP_SECURITY_MODULE Security Information
+ * @brief The Security Information API provides functions for managing the Security information.
+ * @section CAPI_NETWORK_WIFI_MANAGER_AP_SECURITY_MODULE Required Header
+ * \#include <wifi-manager.h>
  *
  * @section CAPI_NETWORK_WIFI_MANAGER_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_MANAGER_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 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 using features in your application can be found in the <a href="https://developer.tizen.org/development/getting-started/native-application/understanding-tizen-programming/application-filtering"><b>Feature List</b>.</a>
- *
  */
 
+
 /**
- * @defgroup CAPI_NETWORK_WIFI_MANAGER_AP_SECURITY_EAP_MODULE  EAP
- * @brief The EAP API provides functions for managing the EAP information.
  * @ingroup CAPI_NETWORK_WIFI_MANAGER_AP_SECURITY_MODULE
- *
- * @section CAPI_NETWORK_WIFI_MANAGER_AP_SECURITY_EAP_MODULE  Required Header
- *   \#include <wifi.h>
+ * @defgroup CAPI_NETWORK_WIFI_MANAGER_AP_SECURITY_EAP_MODULE EAP
+ * @brief The EAP API provides functions for managing the EAP information.
+ * @section CAPI_NETWORK_WIFI_MANAGER_AP_SECURITY_EAP_MODULE Required Header
+ * \#include <wifi.h>
  *
  * @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.
  * @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
- *
  * 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 using features in your application can be found in the <a href="https://developer.tizen.org/development/getting-started/native-application/understanding-tizen-programming/application-filtering"><b>Feature List</b>.</a>
- *
  */
 
 
 /**
- * @defgroup CAPI_NETWORK_WIFI_MANAGER_CONFIG_MODULE  Wi-Fi Configuration
- * @brief The Configuration API provides functions for managing the configuration of Wi-Fi.
  * @ingroup CAPI_NETWORK_WIFI_MANAGER_MODULE
- *
- * @section CAPI_NETWORK_WIFI_MANAGER_CONFIG_MODULE  Required Header
- *   \#include <wifi-manager.h>
+ * @defgroup CAPI_NETWORK_WIFI_MANAGER_CONFIG_MODULE Wi-Fi Configuration
+ * @brief The Configuration API provides functions for managing the configuration of Wi-Fi.
+ * @section CAPI_NETWORK_WIFI_MANAGER_CONFIG_MODULE Required Header
+ * \#include <wifi-manager.h>
  *
  * @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.
  * @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
- *
  * 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 using features in your application can be found in the <a href="https://developer.tizen.org/development/getting-started/native-application/understanding-tizen-programming/application-filtering"><b>Feature List</b>.</a>
- *
  */
 
+
 /**
+ * @ingroup CAPI_NETWORK_WIFI_MANAGER_MODULE
  * @defgroup CAPI_NETWORK_WIFI_MANAGER_TDLS_MODULE Wi-Fi TDLS
  * @brief The TDLS APIs for managing TDLS.
- * @ingroup CAPI_NETWORK_WIFI_MANAGER_MODULE
- *
- * @section CAPI_NETWORK_WIFI_MANAGER_TDLS_MODULE  Required Header
- *   \#include <wifi-manager.h>
+ * @section CAPI_NETWORK_WIFI_MANAGER_TDLS_MODULE Required Header
+ * \#include <wifi-manager.h>
  *
  * @section CAPI_NETWORK_WIFI_MANAGER_TDLS_MODULE_OVERVIEW Overview
  * The TDLS APIs for managing TDLS.
  * @section CAPI_NETWORK_WIFI_MANAGER_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 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.
- *
+ * 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 using features in your application can be found in the <a href="https://developer.tizen.org/development/getting-started/native-application/understanding-tizen-programming/application-filtering"><b>Feature List</b>.</a>
- *
  */