From: Taejin Woo Date: Wed, 11 May 2016 01:35:43 +0000 (+0900) Subject: Add CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE group X-Git-Tag: submit/submit/tizen/20160620.042720/20160620.042801^2 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=73a0a3f5345bf889556dcdbd33e594160e55bd86;p=platform%2Fcore%2Fapi%2Fbluetooth.git Add CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE group This module is for HID Device APIs Change-Id: I43e5c0843b9cb7cf1058f870dd704264b9c21a53 Signed-off-by: Taejin Woo --- diff --git a/doc/bluetooth_doc.h b/doc/bluetooth_doc.h index 88b6316..0ba5cf5 100644 --- a/doc/bluetooth_doc.h +++ b/doc/bluetooth_doc.h @@ -504,6 +504,7 @@ */ /** + * @if MOBILE * @defgroup CAPI_NETWORK_BLUETOOTH_HID_MODULE Bluetooth HID * @brief Bluetooth HID(Human Interface Device) API provides functions for connecting to Bluetooth HID such as keyboards and mouse. * @ingroup CAPI_NETWORK_BLUETOOTH_MODULE @@ -527,6 +528,92 @@ * 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 Feature Element. + * @endif + */ + +/** + * @if WEARABLE + * @defgroup CAPI_NETWORK_BLUETOOTH_HID_MODULE Bluetooth HID + * @brief Bluetooth HID(Human Interface Device) API provides functions for connecting to Bluetooth HID such as keyboards and mouse. + * @ingroup CAPI_NETWORK_BLUETOOTH_MODULE + * + * @section CAPI_NETWORK_BLUETOOTH_HID_MODULE_HEADER Required Header + * \#include + * + * @section CAPI_NETWORK_BLUETOOTH_HID_MODULE_OVERVIEW Overview + * In HID Profile, there are two roles - @a Host and @a Device. + * The @a Host is a device that uses or requests the services of a HID. The @a Device is a device that provides the service of human data input and output to and from th + * + * @section CAPI_NETWORK_BLUETOOTH_HID_MODULE_FEATURE Related Features + * This API is related with the following features:\n + * - http://tizen.org/feature/network.bluetooth.hid\n + * - http://tizen.org/feature/network.bluetooth.hid_device\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 applicati + * + * 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 + * + * More details on featuring your application can be found from Feat + * @endif + */ + + +/** + * @if WEARABLE + * @defgroup CAPI_NETWORK_BLUETOOTH_HID_HOST_MODULE Bluetooth HID Host + * @brief Bluetooth HID(Human Interface Device) API provides functions for connecting to Bluetooth HID such as keyboards and mouse. + * @ingroup CAPI_NETWORK_BLUETOOTH_HID_MODULE + * + * @section CAPI_NETWORK_BLUETOOTH_HID_MODULE_HEADER Required Header + * \#include + * + * @section CAPI_NETWORK_BLUETOOTH_HID_MODULE_OVERVIEW Overview + * In HID Profile, there are two roles - @a Host and @a Device. + * The @a Host is a device that uses or requests the services of a HID. The @a Device is a device that provides the service of human data input and output to and from th + * This API only supports @a Host role. + * + * @section CAPI_NETWORK_BLUETOOTH_HID_MODULE_FEATURE Related Features + * This API is related with the following features:\n + * - http://tizen.org/feature/network.bluetooth.hid\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 applicati + * + * 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 + * + * More details on featuring your application can be found from Feat + * @endif + */ + +/** + * @if WEARABLE + * @defgroup CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE Bluetooth HID Device + * @brief The Bluetooth HID (Human Interface Device) API provides functions for connecting Bluetooth HID such as keyboards and mice. + * @ingroup CAPI_NETWORK_BLUEETOOTH_HID_MODULE + * + * @section CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE_HEADER Required Header + * \#include + * + * @section CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE_OVERVIEW Overview + * In HID Profile, there are two roles - @a Host and @a Device. + * The @a Host is a device that uses or requests the services of a HID. The @a Device is a device that provides the service of human data input and output to and from the @a Host. + * This API supports the @a Device role. + * + * @section CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE_FEATURE Related Features + * This API is related to the following features:\n + * - http://tizen.org/feature/network.bluetooth.hid_device\n + * + * It is recommended to use features 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 your application's actions.\n + * + * To ensure your application runs only on devices with the required features, please declare 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 Feature Element description. + * @endif * */