2 * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 #ifndef __TIZEN_NETWORK_TETHERING_DOC_H__
19 #define __TIZEN_NETWORK_TETHERING_DOC_H__
24 * @defgroup CAPI_NETWORK_TETHERING_MODULE Tethering
25 * @brief Tethering provides three kinds of tethering : Wi-Fi, Bluetooth and USB.
26 * @ingroup CAPI_NETWORK_FRAMEWORK
28 * @section CAPI_NETWORK_TETHERING_MODULE_HEADER Required Header
29 * \#include <tethering.h>
31 * @section CAPI_NETWORK_TETHERING_MODULE_OVERVIEW Overview
32 * Tethering Service consists of @ref CAPI_NETWORK_TETHERING_MANAGER_MODULE and @ref CAPI_NETWORK_TETHERING_CLIENT_MODULE.
36 * <th>Description</th>
39 * <td>@ref CAPI_NETWORK_TETHERING_MANAGER_MODULE </td>
40 * <td>Provides functions for managing the tethering.</td>
43 * <td>@ref CAPI_NETWORK_TETHERING_CLIENT_MODULE </td>
44 * <td>Provides functions for getting the information about a connected client.</td>
51 * @defgroup CAPI_NETWORK_TETHERING_MANAGER_MODULE Tethering Manager
52 * @brief Tethering provides API to manage the tethering.
53 * @ingroup CAPI_NETWORK_TETHERING_MODULE
55 * @section CAPI_NETWORK_TETHERING_MANAGER_MODULE_HEADER Required Header
56 * \#include <tethering.h>
58 * @section CAPI_NETWORK_TETHERING_MANAGER_MODULE_OVERVIEW Overview
59 * This set of functions is used to manage tethering.
60 * There are three kinds of tethering : Wi-Fi, Bluetooth and USB. \n
61 * @section CAPI_NETWORK_TETHERING_MANAGER_MODULE_FEATURE Related Features
62 * This API is related with the following features:\n
63 * - http://tizen.org/feature/network.tetheirng\n
64 * - http://tizen.org/feature/network.tethering.wifi\n
65 * - http://tizen.org/feature/network.tethering.bluetooth\n
66 * - http://tizen.org/feature/network.tethering.usb\n
68 * It is recommended to design feature related codes in your application for reliability.\n
70 * 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
72 * 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
74 * 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>
80 * @defgroup CAPI_NETWORK_TETHERING_WIFI_MODULE Tethering Wi-Fi
81 * @brief Tethering Wi-Fi provides API to set the configuration of tethering Wi-Fi.
82 * @ingroup CAPI_NETWORK_TETHERING_MANAGER_MODULE
84 * @section CAPI_NETWORK_TETHERING_WIFI_MODULE_HEADER Required Header
85 * \#include <tethering.h>
87 * @section CAPI_NETWORK_TETHERING_WIFI_MODULE_OVERVIEW Overview
88 * This set of functions is used to manage security types, passphrases and so on.
89 * @section CAPI_NETWORK_TETHERING_WIFI_MODULE_FEATURE Related Features
90 * This API is related with the following features:\n
91 * - http://tizen.org/feature/network.tethering.wifi\n
93 * It is recommended to design feature related codes in your application for reliability.\n
95 * 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
97 * 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
99 * 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>
105 * @defgroup CAPI_NETWORK_TETHERING_CLIENT_MODULE Tethering Client
106 * @brief Client provides API to get the information about a connected client.
107 * @ingroup CAPI_NETWORK_TETHERING_MODULE
109 * @section CAPI_NETWORK_TETHERING_CLIENT_MODULE_HEADER Required Header
110 * \#include <tethering.h>
112 * @section CAPI_NETWORK_TETHERING_CLIENT_MODULE_OVERVIEW Overview
113 * This set of functions is used to get information about a connected client.
114 * @section CAPI_NETWORK_TETHERING_CLIENT_MODULE_FEATURE Related Features
115 * This API is related with the following features:\n
116 * - http://tizen.org/feature/tethering\n
117 * - http://tizen.org/feature/tethering.wifi\n
118 * - http://tizen.org/feature/tethering.bluetooth\n
119 * - http://tizen.org/feature/tethering.usb\n
121 * It is recommended to design feature related codes in your application for reliability.\n
123 * 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
125 * 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
127 * 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>
131 #endif /* __TIZEN_NETWORK_MOBILE_AP_DOC_H__ */