From cc31c7ccd459ae94c92148a96ac1a8ed5ca5ba86 Mon Sep 17 00:00:00 2001 From: Aditi Hilbert Date: Thu, 23 Aug 2018 18:10:42 -0700 Subject: [PATCH] Configured the doxygen comments to be pulled into docs for BLE --- docs/ble_hs/ble_att.rst | 7 +++++-- docs/ble_hs/ble_gap.rst | 8 ++++---- docs/ble_hs/ble_gattc.rst | 8 ++++---- docs/ble_hs/ble_gatts.rst | 8 ++++---- 4 files changed, 17 insertions(+), 14 deletions(-) diff --git a/docs/ble_hs/ble_att.rst b/docs/ble_hs/ble_att.rst index 3e7e9efa1..2025784dd 100644 --- a/docs/ble_hs/ble_att.rst +++ b/docs/ble_hs/ble_att.rst @@ -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: diff --git a/docs/ble_hs/ble_gap.rst b/docs/ble_hs/ble_gap.rst index 4daeef81f..d5c998541 100644 --- a/docs/ble_hs/ble_gap.rst +++ b/docs/ble_hs/ble_gap.rst @@ -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: diff --git a/docs/ble_hs/ble_gattc.rst b/docs/ble_hs/ble_gattc.rst index 3ed1fc0ad..4668c5d91 100644 --- a/docs/ble_hs/ble_gattc.rst +++ b/docs/ble_hs/ble_gattc.rst @@ -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: diff --git a/docs/ble_hs/ble_gatts.rst b/docs/ble_hs/ble_gatts.rst index 871ea831a..0a823f0b4 100644 --- a/docs/ble_hs/ble_gatts.rst +++ b/docs/ble_hs/ble_gatts.rst @@ -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: