Skip to content

Commit b30ce53

Browse files
jori-nordicfabiobaltieri
authored andcommitted
Bluetooth: host: clarify which GATT subscribe flags are internal
Add a note to the GATT subscription flags' docstring to indicate what flags are used internally and are not part of the API. We might want to move them in their own struct member, something like `internal_flags` in a subsequent change. Signed-off-by: Jonathan Rico <[email protected]>
1 parent a7746ad commit b30ce53

File tree

1 file changed

+4
-0
lines changed
  • include/zephyr/bluetooth

1 file changed

+4
-0
lines changed

include/zephyr/bluetooth/gatt.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1778,6 +1778,8 @@ enum {
17781778
*
17791779
* If set, indicates write operation is pending waiting remote end to
17801780
* respond.
1781+
*
1782+
* @note Internal use only.
17811783
*/
17821784
BT_GATT_SUBSCRIBE_FLAG_WRITE_PENDING,
17831785

@@ -1788,6 +1790,8 @@ enum {
17881790
*
17891791
* Used to avoid sending subscription requests multiple times when the
17901792
* @kconfig{CONFIG_BT_GATT_AUTO_RESUBSCRIBE} quirk is enabled.
1793+
*
1794+
* @note Internal use only.
17911795
*/
17921796
BT_GATT_SUBSCRIBE_FLAG_SENT,
17931797

0 commit comments

Comments
 (0)