michaelh/zephyr
1
0
Fork 0
Code Releases Activity

Documentation: Update bt_gatt_discover_params & bt_gatt_discover_params

Browse source 
Documentation for `bt_gatt_subscribe_params` and
`bt_gatt_discover_params` is not complete.
`CONFIG_BT_GATT_AUTO_DISCOVER_CCC` need to be selected so Doxygen add
see `end_handle`, `disc_params` and `sub_params`.

Signed-off-by: Théo Battrel <theo.battrel@nordicsemi.no>
This commit is contained in:
Théo Battrel 2023-09-18 13:00:56 +02:00 • committed by Fabio Baltieri
commit da11b5fc09
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
include/zephyr/bluetooth/gatt.h
View file

@ -1463,10 +1463,10 @@ struct bt_gatt_discover_params {
uint16_t end_handle;
/** Discover type */
uint8_t type;
#if defined(CONFIG_BT_GATT_AUTO_DISCOVER_CCC)
#if defined(CONFIG_BT_GATT_AUTO_DISCOVER_CCC) || defined(__DOXYGEN__)
/** Only for stack-internal use, used for automatic discovery. */
struct bt_gatt_subscribe_params *sub_params;
#endif /* defined(CONFIG_BT_GATT_AUTO_DISCOVER_CCC) */
#endif /* defined(CONFIG_BT_GATT_AUTO_DISCOVER_CCC) || defined(__DOXYGEN__) */
#if defined(CONFIG_BT_EATT)
enum bt_att_chan_opt chan_opt;
#endif /* CONFIG_BT_EATT */
@ -1831,12 +1831,12 @@ struct bt_gatt_subscribe_params {
uint16_t value_handle;
/** Subscribe CCC handle */
uint16_t ccc_handle;
#if defined(CONFIG_BT_GATT_AUTO_DISCOVER_CCC)
#if defined(CONFIG_BT_GATT_AUTO_DISCOVER_CCC) || defined(__DOXYGEN__)
/** Subscribe End handle (for automatic discovery) */
uint16_t end_handle;
/** Discover parameters used when ccc_handle = 0 */
struct bt_gatt_discover_params *disc_params;
#endif /* CONFIG_BT_GATT_AUTO_DISCOVER_CCC */
#endif /* defined(CONFIG_BT_GATT_AUTO_DISCOVER_CCC) || defined(__DOXYGEN__) */
/** Subscribe value */
uint16_t value;
#if defined(CONFIG_BT_SMP)