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 <joakim.andersson@nordicsemi.no>
This commit is contained in:
Joakim Andersson 2020-04-28 19:32:02 +02:00 committed by Carles Cufí
commit 28e99b7efb
3 changed files with 30 additions and 0 deletions

View file

@ -9,3 +9,11 @@ API Reference
.. doxygengroup:: bt_gap .. doxygengroup:: bt_gap
:project: Zephyr :project: Zephyr
:members: :members:
.. doxygengroup:: bt_addr
:project: Zephyr
:members:
.. doxygengroup:: bt_gap_defines
:project: Zephyr
:members:

View file

@ -17,6 +17,13 @@
extern "C" { extern "C" {
#endif #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_PUBLIC 0x00
#define BT_ADDR_LE_RANDOM 0x01 #define BT_ADDR_LE_RANDOM 0x01
#define BT_ADDR_LE_PUBLIC_ID 0x02 #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); return BT_ADDR_IS_STATIC(&addr->a);
} }
/**
* @}
*/
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif

View file

@ -15,6 +15,13 @@
extern "C" { extern "C" {
#endif #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) */ /** Company Identifiers (see Bluetooth Assigned Numbers) */
#define BT_COMP_ID_LF 0x05f1 /* The Linux Foundation */ #define BT_COMP_ID_LF 0x05f1 /* The Linux Foundation */
@ -128,6 +135,10 @@ enum {
*/ */
#define BT_GAP_ADV_HIGH_DUTY_CYCLE_MAX_TIMEOUT 128 #define BT_GAP_ADV_HIGH_DUTY_CYCLE_MAX_TIMEOUT 128
/**
* @}
*/
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif