Skip to content

Commit e99d7a0

Browse files
Thalleynashif
authored andcommitted
Bluetooth: PBP: Add missing documentation in pbp.h
Add missing documentation for some defintions in pbp.h Signed-off-by: Emil Gydesen <[email protected]>
1 parent 5023c37 commit e99d7a0

File tree

1 file changed

+14
-1
lines changed
  • include/zephyr/bluetooth/audio

1 file changed

+14
-1
lines changed

include/zephyr/bluetooth/audio/pbp.h

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
1+
/**
2+
* @file
3+
* @brief Public Broadcast Profile (PBP) APIs.
4+
*/
15
/*
26
* Copyright 2023 NXP
7+
* Copyright (c) 2024 Nordic Semiconductor ASA
38
*
49
* SPDX-License-Identifier: Apache-2.0
510
*/
@@ -17,6 +22,9 @@
1722
*
1823
* @ingroup bluetooth
1924
* @{
25+
*
26+
* The Public Broadcast Profile (PBP) is used for public broadcasts by providing additional
27+
* information in the advertising data.
2028
*/
2129

2230
#include <zephyr/bluetooth/audio/audio.h>
@@ -30,7 +38,12 @@
3038
extern "C" {
3139
#endif
3240

33-
/* PBA Service UUID + Public Broadcast Announcement features + Metadata Length */
41+
/**
42+
* @brief Minimum size of the Public Broadcast Announcement
43+
*
44+
* It contains the Public Broadcast Announcement UUID (2), the Public Broadcast Announcement
45+
* features (1) and the metadata length (1)
46+
*/
3447
#define BT_PBP_MIN_PBA_SIZE (BT_UUID_SIZE_16 + 1 + 1)
3548

3649
/** Public Broadcast Announcement features */

0 commit comments

Comments
 (0)