doc/tethering_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_TETHERING_DOC_H__
  19 #define __TIZEN_NETWORK_TETHERING_DOC_H__
  20
  21
  22 /**
  23  * @internal
  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
  27  *
  28  * @section CAPI_NETWORK_TETHERING_MODULE_HEADER Required Header
  29  *   \#include <tethering.h>
  30  *
  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.
  33  * <table>
  34  * <tr>
  35  *    <th>API</th>
  36  *    <th>Description</th>
  37  * </tr>
  38  * <tr>
  39  *    <td>@ref CAPI_NETWORK_TETHERING_MANAGER_MODULE </td>
  40  *    <td>Provides functions for managing the tethering.</td>
  41  * </tr>
  42  * <tr>
  43  *    <td>@ref CAPI_NETWORK_TETHERING_CLIENT_MODULE </td>
  44  *    <td>Provides functions for getting the information about a connected client.</td>
  45  * </tr>
  46  * </table>
  47  */
  48
  49 /**
  50  * @internal
  51  * @defgroup CAPI_NETWORK_TETHERING_MANAGER_MODULE Tethering Manager
  52  * @brief Tethering provides API to manage the tethering.
  53  * @ingroup CAPI_NETWORK_TETHERING_MODULE
  54  *
  55  * @section CAPI_NETWORK_TETHERING_MANAGER_MODULE_HEADER Required Header
  56  *   \#include <tethering.h>
  57  *
  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.wifi.direct\n
  66  * - http://tizen.org/feature/network.tethering.bluetooth\n
  67  * - http://tizen.org/feature/network.tethering.usb\n
  68  *
  69  * It is recommended to design feature related codes in your application for reliability.\n
  70  *
  71  * 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  *
  73  * 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  *
  75  * 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>
  76  *
  77  */
  78
  79 /**
  80  * @internal
  81  * @defgroup CAPI_NETWORK_TETHERING_WIFI_MODULE Tethering Wi-Fi
  82  * @brief Tethering Wi-Fi provides API to set the configuration of tethering Wi-Fi.
  83  * @ingroup CAPI_NETWORK_TETHERING_MANAGER_MODULE
  84  *
  85  * @section CAPI_NETWORK_TETHERING_WIFI_MODULE_HEADER Required Header
  86  *   \#include <tethering.h>
  87  *
  88  * @section CAPI_NETWORK_TETHERING_WIFI_MODULE_OVERVIEW Overview
  89  * This set of functions is used to manage security types, passphrases and so on.
  90  * @section CAPI_NETWORK_TETHERING_WIFI_MODULE_FEATURE Related Features
  91  * This API is related with the following features:\n
  92  * - http://tizen.org/feature/network.tethering.wifi\n
  93  * - http://tizen.org/feature/network.tethering.wifi.direct\n
  94  *
  95  * It is recommended to design feature related codes in your application for reliability.\n
  96  *
  97  * 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
  98  *
  99  * 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
 100  *
 101  * 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>
 102  *
 103  */
 104
 105 /**
 106  * @internal
 107  * @defgroup CAPI_NETWORK_TETHERING_CLIENT_MODULE Tethering Client
 108  * @brief Client provides API to get the information about a connected client.
 109  * @ingroup CAPI_NETWORK_TETHERING_MODULE
 110  *
 111  * @section CAPI_NETWORK_TETHERING_CLIENT_MODULE_HEADER Required Header
 112  *   \#include <tethering.h>
 113  *
 114  * @section CAPI_NETWORK_TETHERING_CLIENT_MODULE_OVERVIEW Overview
 115  * This set of functions is used to get information about a connected client.
 116  * @section CAPI_NETWORK_TETHERING_CLIENT_MODULE_FEATURE Related Features
 117  * This API is related with the following features:\n
 118  * - http://tizen.org/feature/tethering\n
 119  * - http://tizen.org/feature/tethering.wifi\n
 120  * - http://tizen.org/feature/network.tethering.wifi.direct\n
 121  * - http://tizen.org/feature/tethering.bluetooth\n
 122  * - http://tizen.org/feature/tethering.usb\n
 123  *
 124  * It is recommended to design feature related codes in your application for reliability.\n
 125  *
 126  * 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
 127  *
 128  * 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
 129  *
 130  * 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  *
 132  */
 133
 134 #endif /* __TIZEN_NETWORK_MOBILE_AP_DOC_H__ */