summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPyun DoHyun <dh79.pyun@samsung.com>2016-06-19 21:24:57 -0700
committerGerrit Code Review <gerrit@review.vlan103.tizen.org>2016-06-19 21:24:57 -0700
commit54b19dd139ab457c777bb43d7e5f323fc41307a9 (patch)
tree985eecb25295d10ec2529bf5963db1b0d855112a
parent00a0fd51e36030b1a6fe8d6278ddc49e53f362fe (diff)
parent73a0a3f5345bf889556dcdbd33e594160e55bd86 (diff)
downloadbluetooth-54b19dd139ab457c777bb43d7e5f323fc41307a9.tar.gz
bluetooth-54b19dd139ab457c777bb43d7e5f323fc41307a9.tar.bz2
bluetooth-54b19dd139ab457c777bb43d7e5f323fc41307a9.zip
Merge "Add CAPI_NETWORK_BLUETOOTH_HID_DEVICE_MODULE group" into tizensubmit/tizen/20160620.042720submit/submit/tizen/20160620.042720/20160620.042801
-rw-r--r--doc/bluetooth_doc.h87
1 files changed, 87 insertions, 0 deletions
diff --git a/doc/bluetooth_doc.h b/doc/bluetooth_doc.h
index 695245c..9e75625 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 <a href="https://developer.tizen.org/development/tools/native-tools/manifest-text-editor#feature"><b>Feature Element</b>.</a>
+ * @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 <bluetooth.h>
+ *
+ * @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 <a href="https://developer.tizen.org/development/tools/native-tools/manifest-text-editor#feature"><b>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 <bluetooth.h>
+ *
+ * @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 <a href="https://developer.tizen.org/development/tools/native-tools/manifest-text-editor#feature"><b>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 <bluetooth.h>
+ *
+ * @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 <a href="https://developer.tizen.org/development/tools/native-tools/manifest-text-editor#feature"><b>Feature Element</b> description.</a>
+ * @endif
*
*/