Merge pull request #167 from aditihilbert/master

Configured the doxygen comments to be pulled into docs for BLE
This commit is contained in:
aditihilbert
2018-08-23 18:17:39 -07:00
committed by GitHub
4 changed files with 17 additions and 14 deletions
+5 -2
View File
@@ -14,6 +14,9 @@ higher level GATT profile, which sits directly above ATT in the host. NimBLE exp
which are not encompassed by higher level GATT functions. This section documents the ATT functionality that the NimBLE
host exposes to the application.
Header
API
~~~~~~
.. doxygenfile:: nimble/host/include/host/ble_hs.h
.. doxygengroup:: bt_host
:content-only:
:members:
+4 -4
View File
@@ -6,9 +6,9 @@ Introduction
The Generic Access Profile (GAP) is responsible for all connecting, advertising, scanning, and connection updating operations.
Header
API
~~~~~~
.. code-block:: cpp
#include "host/ble_hs.h"
.. doxygengroup:: bt_host_gap
:content-only:
:members:
+4 -4
View File
@@ -7,9 +7,9 @@ Introduction
The Generic Attribute Profile (GATT) manages all activities involving services, characteristics, and descriptors. The
client half of the GATT API initiates GATT procedures.
Header
API
~~~~~~
.. code-block:: cpp
#include "host/ble_hs.h"
.. doxygengroup:: bt_gatt
:content-only:
:members:
+4 -4
View File
@@ -7,9 +7,9 @@ Introduction
The Generic Attribute Profile (GATT) manages all activities involving services, characteristics, and descriptors. The
server half of the GATT API handles registration and responding to GATT clients.
Header
API
~~~~~~
.. code-block:: cpp
#include "host/ble_hs.h"
.. doxygengroup:: bt_gatt
:content-only:
:members: