Skip to content

Commit 77b6035

Browse files
HaavardReikartben
authored andcommitted
Bluetooth: Host: Doc: Name enums in gap.h
Names the enums declared in `gap.h` and replaces references to them with Doxygen references (@ref). Signed-off-by: Håvard Reierstad <[email protected]>
1 parent 7512eb0 commit 77b6035

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

include/zephyr/bluetooth/bluetooth.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1741,7 +1741,7 @@ int bt_le_ext_adv_get_info(const struct bt_le_ext_adv *adv,
17411741
* @param addr Advertiser LE address and type.
17421742
* @param rssi Strength of advertiser signal.
17431743
* @param adv_type Type of advertising response from advertiser.
1744-
* Uses the BT_GAP_ADV_TYPE_* values.
1744+
* Uses the @ref bt_gap_adv_type values.
17451745
* @param buf Buffer containing advertiser data.
17461746
*/
17471747
typedef void bt_le_scan_cb_t(const bt_addr_le_t *addr, int8_t rssi,
@@ -2584,7 +2584,7 @@ struct bt_le_scan_recv_info {
25842584
/**
25852585
* @brief Advertising packet type.
25862586
*
2587-
* Uses the BT_GAP_ADV_TYPE_* value.
2587+
* Uses the @ref bt_gap_adv_type value.
25882588
*
25892589
* May indicate that this is a scan response if the type is
25902590
* @ref BT_GAP_ADV_TYPE_SCAN_RSP.
@@ -2594,7 +2594,7 @@ struct bt_le_scan_recv_info {
25942594
/**
25952595
* @brief Advertising packet properties bitfield.
25962596
*
2597-
* Uses the BT_GAP_ADV_PROP_* values.
2597+
* Uses the @ref bt_gap_adv_prop values.
25982598
* May indicate that this is a scan response if the value contains the
25992599
* @ref BT_GAP_ADV_PROP_SCAN_RESPONSE bit.
26002600
*

include/zephyr/bluetooth/gap.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -740,7 +740,7 @@ extern "C" {
740740
*/
741741

742742
/** LE PHY types */
743-
enum {
743+
enum bt_gap_le_phy {
744744
/** Convenience macro for when no PHY is set. */
745745
BT_GAP_LE_PHY_NONE = 0,
746746
/** LE 1M PHY */
@@ -760,7 +760,7 @@ enum {
760760
};
761761

762762
/** Advertising PDU types */
763-
enum {
763+
enum bt_gap_adv_type {
764764
/** Scannable and connectable advertising. */
765765
BT_GAP_ADV_TYPE_ADV_IND = 0x00,
766766
/** Directed connectable advertising. */
@@ -776,7 +776,7 @@ enum {
776776
};
777777

778778
/** Advertising PDU properties */
779-
enum {
779+
enum bt_gap_adv_prop {
780780
/** Connectable advertising. */
781781
BT_GAP_ADV_PROP_CONNECTABLE = BIT(0),
782782
/** Scannable advertising. */
@@ -1054,7 +1054,7 @@ enum {
10541054
(BT_GAP_US_TO_CONN_EVENT_LEN((_event_len) * USEC_PER_MSEC))
10551055

10561056
/** Constant Tone Extension (CTE) types */
1057-
enum {
1057+
enum bt_gap_cte {
10581058
/** Angle of Arrival */
10591059
BT_GAP_CTE_AOA = 0x00,
10601060
/** Angle of Departure with 1 us slots */
@@ -1066,7 +1066,7 @@ enum {
10661066
};
10671067

10681068
/** @brief Peripheral sleep clock accuracy (SCA) in ppm (parts per million) */
1069-
enum {
1069+
enum bt_gap_sca {
10701070
BT_GAP_SCA_UNKNOWN = 0, /**< Unknown */
10711071
BT_GAP_SCA_251_500 = 0, /**< 251 ppm to 500 ppm */
10721072
BT_GAP_SCA_151_250 = 1, /**< 151 ppm to 250 ppm */

include/zephyr/bluetooth/iso.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ struct bt_iso_chan_io_qos {
228228
*/
229229
uint16_t sdu;
230230
/**
231-
* @brief Channel PHY - See the BT_GAP_LE_PHY_* values.
231+
* @brief Channel PHY - See the @ref bt_gap_le_phy values.
232232
*
233233
* Setting @ref BT_GAP_LE_PHY_NONE is invalid.
234234
*/
@@ -432,7 +432,7 @@ struct bt_iso_cig_param {
432432
* @brief Channel peripherals sleep clock accuracy Only for CIS
433433
*
434434
* Shall be worst case sleep clock accuracy of all the peripherals.
435-
* For possible values see the BT_GAP_SCA_* values.
435+
* For possible values, see @ref bt_gap_sca.
436436
* If unknown for the peripherals, this should be set to @ref BT_GAP_SCA_UNKNOWN.
437437
*/
438438
uint8_t sca;

0 commit comments

Comments
 (0)