michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: Bluetooth: Document the services APIs

Browse source 
The Bluetooth documentation was missing all the Doxygen API information
regarding the standard services implemented in the Host. Import the
Doxygen API doc in a single page.

Fixes #42520.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
This commit is contained in:
Carles Cufi 2022-05-23 15:47:06 +02:00 • committed by Carles Cufí
commit 35a00551a8
3 changed files with 26 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
doc/connectivity/bluetooth/api/index.rst
View file

@ -22,6 +22,7 @@ Bluetooth APIs
mesh.rst mesh.rst
microphone.rst microphone.rst
rfcomm.rst rfcomm.rst
services.rst
sdp.rst sdp.rst
volume.rst volume.rst
uuid.rst uuid.rst

24
doc/connectivity/bluetooth/api/services.rst Normal file
View file

@ -0,0 +1,24 @@
.. _bluetooth_services:
Bluetooth standard services
###########################
Battery Service
***************
.. doxygengroup:: bt_bas
Heart Rate Service
******************
.. doxygengroup:: bt_hrs
Immediate Alert Service
***********************
.. doxygengroup:: bt_ias
Object Transfer Service
***********************
.. doxygengroup:: bt_ots

1
doc/known-warnings.txt
View file

@ -15,3 +15,4 @@
.*Duplicate C declaration.*\n.*'\.\. c:.*:: .*struct in_addr.*'.* .*Duplicate C declaration.*\n.*'\.\. c:.*:: .*struct in_addr.*'.*
.*Duplicate C declaration.*\n.*'\.\. c:.*:: .*struct in6_addr.*'.* .*Duplicate C declaration.*\n.*'\.\. c:.*:: .*struct in6_addr.*'.*
.*Duplicate C declaration.*\n.*'\.\. c:.*:: .*struct net_if.*'.* .*Duplicate C declaration.*\n.*'\.\. c:.*:: .*struct net_if.*'.*
.*Duplicate C declaration.*\n.*'\.\. c:struct:: bt_ots_init'.*