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

LE Audio: Reach 100% documentation coverage #75219

Merged
merged 20 commits into from
Jul 12, 2024

Conversation

Thalley
Copy link
Collaborator

@Thalley Thalley commented Jun 30, 2024

Updates, fixes and reformats LE Audio documentation in the header files.

fixes #64496

@Thalley Thalley force-pushed the audio_doc_coverage branch 7 times, most recently from dce004f to d801c6b Compare July 3, 2024 11:12
@Thalley Thalley changed the title Audio doc coverage LE Audio: Reach 100% documentation coverage Jul 3, 2024
@Thalley Thalley marked this pull request as ready for review July 3, 2024 12:27
@Thalley Thalley added this to the v3.7.0 milestone Jul 3, 2024
Comment on lines +47 to +48
#define BT_TBS_CALL_FLAG_SET_INCOMING(flag) (flag &= ~BT_TBS_CALL_FLAG_OUTGOING)
#define BT_TBS_CALL_FLAG_SET_OUTGOING(flag) (flag |= BT_TBS_CALL_FLAG_OUTGOING)
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Moved from the public API as they do not belong there

@Thalley Thalley force-pushed the audio_doc_coverage branch 2 times, most recently from 44d00aa to e4b39f6 Compare July 9, 2024 09:12
@Thalley Thalley requested a review from aescolar July 9, 2024 09:16
Add missing documentation for some defintions in audio.h
Makes formatting and placement of @brief consistent.

Signed-off-by: Emil Gydesen <[email protected]>
Add missing documentation for some defintions in bap_lc3_presets.h
Also added missing C++ guards, group and version.
Fixes some formatting.

Signed-off-by: Emil Gydesen <[email protected]>
Add missing documentation for some defintions in bap.h

Signed-off-by: Emil Gydesen <[email protected]>
Add missing documentation for some defintions in cap.h

Signed-off-by: Emil Gydesen <[email protected]>
Add missing documentation for some defintions in csip.h

Signed-off-by: Emil Gydesen <[email protected]>
Add missing documentation for some defintions in gmap_lc3_presets.h
Also added missing C++ guards, group and version.

Signed-off-by: Emil Gydesen <[email protected]>
Add missing documentation for some defintions in gmap.h
Also added missing C++ guards, group and version.

Signed-off-by: Emil Gydesen <[email protected]>
Add missing documentation for some defintions in has.h

Signed-off-by: Emil Gydesen <[email protected]>
Format documentation for some defintions in lc3.h

Signed-off-by: Emil Gydesen <[email protected]>
Add missing documentation for some defintions in mcc.h

Signed-off-by: Emil Gydesen <[email protected]>
Add missing documentation for some defintions in mcs.h

Signed-off-by: Emil Gydesen <[email protected]>
Add missing documentation for some defintions in media_proxy.h

Signed-off-by: Emil Gydesen <[email protected]>
Add missing documentation for some defintions in micp.h

Signed-off-by: Emil Gydesen <[email protected]>
Add missing documentation for some defintions in pacs.h

Signed-off-by: Emil Gydesen <[email protected]>
Add missing documentation for some defintions in pbp.h

Signed-off-by: Emil Gydesen <[email protected]>
Add missing documentation for some defintions in tbs.h
Moved some internal definitions to tbs_internal.h

Removed invalid TBS technology BT_TBS_TECHNOLOGY_IP that
doesn't exist.

Signed-off-by: Emil Gydesen <[email protected]>
Add missing documentation for some defintions in tmap.h

Signed-off-by: Emil Gydesen <[email protected]>
Add missing documentation for some defintions in vcp.h

Signed-off-by: Emil Gydesen <[email protected]>
Add missing documentation for some defintions in vocs.h

Signed-off-by: Emil Gydesen <[email protected]>
@nashif nashif merged commit eaa2bf0 into zephyrproject-rtos:main Jul 12, 2024
25 checks passed
@Thalley Thalley deleted the audio_doc_coverage branch July 12, 2024 10:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

LE Audio: Reach 100% documentation coverage
8 participants