Correct doxygen
[platform/core/api/wifi-direct.git] / doc / wifi_direct_doc.h
1 /*
2  * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
3  *
4  * Licensed under the Apache License, Version 2.0 (the License);
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an AS IS BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17
18 #ifndef __TIZEN_NETWORK_WIFI_DIRECT_DOC_H__
19 #define __TIZEN_NETWORK_WIFI_DIRECT_DOC_H__
20
21
22 /**
23  * @ingroup CAPI_NETWORK_FRAMEWORK
24  * @defgroup CAPI_NETWORK_WIFI_DIRECT_MODULE Wi-Fi Direct
25  * @brief Wi-Fi Direct provides API to manage Wi-Fi Direct.
26  * @section CAPI_NETWORK_WIFI_DIRECT_MODULE_HEADER Required Header
27  * \#include <wifi-direct.h>
28  *
29  * @section CAPI_NETWORK_WIFI_DIRECT_MODULE_OVERVIEW Overview
30  * This set of functions is used to manage the settings of Wi-Fi Direct.
31  * In addition, this set provides functions to connect and disconnect remote devices using Wi-Fi Direct.
32  *
33  * @section CAPI_NETWORK_WIFI_DIRECT_MANAGER_MODULE_FEATURE Related Features
34  * This API is related with the following features:\n
35  * - http://tizen.org/feature/network.wifi\n
36  * - http://tizen.org/feature/network.wifi.direct\n
37  * - http://tizen.org/feature/network.wifi.direct.display\n
38  * - http://tizen.org/feature/network.wifi.direct.serivce_discovery\n
39  * It is recommended to design feature related codes in your application for reliability.\n
40  * 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
41  * 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
42  * More details on featuring your application can be found from <a href="../org.tizen.gettingstarted/html/native/details/app_filtering_n.htm"><b>Feature List</b>.</a>
43  */
44
45
46 #endif /* __TIZEN_NETWORK_WIFI_DIRECT_DOC_H__ */