Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bluetooth: Host: Doc: Name enums in gap.h #87634

Merged
merged 1 commit into from
Mar 26, 2025

Conversation

HaavardRei
Copy link
Collaborator

@HaavardRei HaavardRei commented Mar 25, 2025

Names the enums declared in gap.h and replaces references to them with Doxygen references (ref).

Names the enums declared in `gap.h` and replaces references to them
with Doxygen references (@ref).

Signed-off-by: Håvard Reierstad <haavard.reierstad@nordicsemi.no>
@zephyrbot zephyrbot added area: Bluetooth ISO Bluetooth LE Isochronous Channels area: Bluetooth Host Bluetooth Host (excluding BR/EDR) area: Bluetooth labels Mar 25, 2025
@HaavardRei HaavardRei added the Trivial Changes that can be reviewed by anyone, i.e. doc changes, minor build system tweaks, etc. label Mar 25, 2025
Copy link
Collaborator

@Thalley Thalley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

We should, however, consider if we want to continue using enums for bitfields. It's nice from a naming perspective, but it's a bit hacky in terms of what a enum is supposed to be :D

@HaavardRei
Copy link
Collaborator Author

LGTM.

We should, however, consider if we want to continue using enums for bitfields. It's nice from a naming perspective, but it's a bit hacky in terms of what a enum is supposed to be :D

Yeah, I agree. The immediate idea is to make the existing API easier to navigate, and bigger changes might come at a later time :)

@kartben kartben merged commit 77b6035 into zephyrproject-rtos:main Mar 26, 2025
35 checks passed
@HaavardRei HaavardRei deleted the host_doc_gap_enum_name branch March 27, 2025 08:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: Bluetooth Host Bluetooth Host (excluding BR/EDR) area: Bluetooth ISO Bluetooth LE Isochronous Channels area: Bluetooth Trivial Changes that can be reviewed by anyone, i.e. doc changes, minor build system tweaks, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants