From 28e99b7efbd049e4fc43a3f3fac80bf40a213af7 Mon Sep 17 00:00:00 2001 From: Joakim Andersson Date: Tue, 28 Apr 2020 19:32:02 +0200 Subject: [PATCH] Bluetooth: doc: Include gap.h and addr.h in documentation build Add gap.h and addr.h to the Generic Access Profile part of the documentation build. Signed-off-by: Joakim Andersson --- doc/reference/bluetooth/gap.rst | 8 ++++++++ include/bluetooth/addr.h | 11 +++++++++++ include/bluetooth/gap.h | 11 +++++++++++ 3 files changed, 30 insertions(+) diff --git a/doc/reference/bluetooth/gap.rst b/doc/reference/bluetooth/gap.rst index 8d70c900d21..b195d480109 100644 --- a/doc/reference/bluetooth/gap.rst +++ b/doc/reference/bluetooth/gap.rst @@ -9,3 +9,11 @@ API Reference .. doxygengroup:: bt_gap :project: Zephyr :members: + +.. doxygengroup:: bt_addr + :project: Zephyr + :members: + +.. doxygengroup:: bt_gap_defines + :project: Zephyr + :members: diff --git a/include/bluetooth/addr.h b/include/bluetooth/addr.h index 394427e3181..e2a0e452c59 100644 --- a/include/bluetooth/addr.h +++ b/include/bluetooth/addr.h @@ -17,6 +17,13 @@ extern "C" { #endif +/** + * @brief Bluetooth device address definitions and utilities. + * @defgroup bt_addr Device Address + * @ingroup bluetooth + * @{ + */ + #define BT_ADDR_LE_PUBLIC 0x00 #define BT_ADDR_LE_RANDOM 0x01 #define BT_ADDR_LE_PUBLIC_ID 0x02 @@ -89,6 +96,10 @@ static inline bool bt_addr_le_is_identity(const bt_addr_le_t *addr) return BT_ADDR_IS_STATIC(&addr->a); } +/** + * @} + */ + #ifdef __cplusplus } #endif diff --git a/include/bluetooth/gap.h b/include/bluetooth/gap.h index 2cc4b9d8b56..8074d40049b 100644 --- a/include/bluetooth/gap.h +++ b/include/bluetooth/gap.h @@ -15,6 +15,13 @@ extern "C" { #endif +/** + * @brief Bluetooth Generic Access Profile defines and Assigned Numbers. + * @defgroup bt_gap_defines Defines and Assigned Numbers + * @ingroup bluetooth + * @{ + */ + /** Company Identifiers (see Bluetooth Assigned Numbers) */ #define BT_COMP_ID_LF 0x05f1 /* The Linux Foundation */ @@ -128,6 +135,10 @@ enum { */ #define BT_GAP_ADV_HIGH_DUTY_CYCLE_MAX_TIMEOUT 128 +/** + * @} + */ + #ifdef __cplusplus } #endif