doc: api: Include Bluetooth in API section

Change-Id: Iee26587476b8f7286d2afe828ba23db49b09d0ce
Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
This commit is contained in:
Johan Hedberg 2016-06-15 10:27:40 +03:00
commit 156dcb751c
2 changed files with 73 additions and 0 deletions

View file

@ -20,6 +20,7 @@ The use of the Zephyr APIs is the same for all platforms and boards.
nanokernel_api.rst
microkernel_api.rst
device.rst
bluetooth.rst
io_interfaces.rst
event_logger.rst
system_log.rst

72
doc/api/bluetooth.rst Normal file
View file

@ -0,0 +1,72 @@
.. _bluetooth_api:
Bluetooth API
#############
.. contents::
:depth: 1
:local:
:backlinks: top
This is the full set of available Bluetooth APIs. It's important to note
that the set that will in practice be available for the application
depends on the exact Kconfig options that have been chosen, since most
of the Bluetooth functionality is build-time selectable. E.g. any
connection-related APIs require :option:`CONFIG_BLUETOOTH_CONN` and any
BR/EDR (Bluetooth Classic) APIs require :option:`CONFIG_BLUETOOTH_BREDR`.
Generic Access Profile (GAP)
****************************
.. doxygengroup:: bt_gap
:project: Zephyr
:content-only:
Connection Management
*********************
.. doxygengroup:: bt_conn
:project: Zephyr
:content-only:
Generic Attribute Profile (GATT)
********************************
.. doxygengroup:: bt_gatt
:project: Zephyr
:content-only:
Universal Unique Identifiers (UUIDs)
************************************
.. doxygengroup:: bt_uuid
:project: Zephyr
:content-only:
Logical Link Control and Adaptation Protocol (L2CAP)
****************************************************
.. doxygengroup:: bt_l2cap
:project: Zephyr
:content-only:
Data Buffers
************
.. doxygengroup:: bt_buf
:project: Zephyr
:content-only:
Persistent Storage
******************
.. doxygengroup:: bt_storage
:project: Zephyr
:content-only:
HCI Drivers
***********
.. doxygengroup:: bt_driver
:project: Zephyr
:content-only: