Skip to content

Commit 3570783

Browse files
KyraLengfeldkartben
authored andcommitted
Bluetooth: Host: Improve bluetooth documentation
This commit adds more detailed description to the "Bluetooth APIs" and "GAP" group within the bluetooth header. Signed-off-by: Kyra Lengfeld <[email protected]>
1 parent aa240e2 commit 3570783

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

include/zephyr/bluetooth/bluetooth.h

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,12 @@
1313

1414
/**
1515
* @brief Bluetooth APIs
16+
* @details The Bluetooth Subsystem Core APIs provide essential functionalities
17+
* to use and manage Bluetooth based communication. These APIs include
18+
* APIs for Bluetooth stack initialization, device discovery,
19+
* connection management, data transmission, profiles and services.
20+
* These APIs support both classic Bluetooth and Bluetooth Low Energy
21+
* (LE) operations.
1622
* @defgroup bluetooth Bluetooth APIs
1723
* @ingroup connectivity
1824
* @{
@@ -35,6 +41,13 @@ extern "C" {
3541

3642
/**
3743
* @brief Generic Access Profile (GAP)
44+
* @details The Generic Access Profile (GAP) defines fundamental Bluetooth
45+
* operations, including device discovery, pairing, and connection
46+
* management. Zephyr's GAP implementation supports both classic
47+
* Bluetooth and Bluetooth Low Energy (LE) functionalities, enabling
48+
* roles such as Broadcaster, Observer, Peripheral, and Central. These
49+
* roles define the device's behavior in advertising, scanning, and
50+
* establishing connections within Bluetooth networks.
3851
* @defgroup bt_gap Generic Access Profile (GAP)
3952
* @since 1.0
4053
* @version 1.0.0

0 commit comments

Comments
 (0)