component/docs: enable generation of API-reference documents for Bluetooth HID host

This commit is contained in:
wangmengyang
2022-03-25 18:20:37 +08:00
committed by gongyantao
parent 028f7779f5
commit d4ac2380e7
6 changed files with 51 additions and 35 deletions
@@ -12,5 +12,6 @@ CLASSIC BT
BT HFP Client <esp_hf_client>
BT HFP AG <esp_hf_ag>
BT HID DEVICE <esp_hidd>
BT HID HOST <esp_hidh>
BT L2CAP <esp_l2cap_bt>
BT SDP <esp_sdp>
@@ -0,0 +1,20 @@
Bluetooth HID Host API
========================
Overview
--------
A Bluetooth HID host is a device or software that is capable of connecting and communicating with Bluetooth HID devices, such as keyboards, mice. Users can use the Bluetooth HID Host APIs to send output data or control commands to the HID devices, enabling them to control the behavior or settings of the devices.
Application Example
-------------------
Check :example:`bluetooth` folder in ESP-IDF examples, which contains the following application:
* Example :example:`bluetooth/esp_hid_host` is implemented using the generic esp_hid APIs. esp_hid APIs are build upon the Bluetooth HID APIs and can be a reference.
API Reference
-------------
.. include-build-file:: inc/esp_hidh_api.inc