Skip to content

Bluetooth data types missing API documentation #3524

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.

Sign up for GitHub

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

Jump to bottom
Closed
zephyrbot opened this issue Apr 27, 2017 · 3 comments
Closed

Bluetooth data types missing API documentation #3524

zephyrbot opened this issue Apr 27, 2017 · 3 comments
Assignees
@jhedberg
Labels
area: Bluetooth bug The issue is a bug, or the PR is fixing a bug priority: low Low impact/importance bug

Comments

@zephyrbot
Copy link
Collaborator

zephyrbot commented Apr 27, 2017 •
edited
Loading

Reported by David Kinder:

Doxygen comments used to create API links to the defining type are missing, causing missing links in API documentation (and lots of warning messages when detailed reporting is enabled):

{code}
WARNING: cpp:type reference target not found: bt_addr_le_t
WARNING: cpp:type reference target not found: bt_conn
WARNING: cpp:type reference target not found: bt_conn
WARNING: cpp:type reference target not found: bt_conn
WARNING: cpp:type reference target not found: bt_conn
WARNING: cpp:type reference target not found: bt_conn
WARNING: cpp:type reference target not found: bt_addr_le_t
WARNING: cpp:type reference target not found: bt_addr_le_t
WARNING: cpp:type reference target not found: bt_conn
WARNING: cpp:type reference target not found: bt_addr_le_t
. . .
{code}

(Imported from Jira ZEP-2083)
@zephyrbot zephyrbot added priority: low Low impact/importance bug area: Bluetooth bug The issue is a bug, or the PR is fixing a bug labels Sep 23, 2017
@nashif
Copy link
Member

nashif commented Nov 2, 2018

@jhedberg please take a look and address, we really need to start closing those low priority issues, either fix them or close them as invalid if not applicable!

@jhedberg
Copy link
Member

jhedberg commented Nov 5, 2018

bt_conn has been documented already for quite a while. bt_addr_le_t hasn't, on the other hand - I'll fix that in a moment.

jhedberg pushed a commit to jhedberg/zephyr that referenced this issue Nov 5, 2018
Bluetooth: Add basic documentation for address types
c7440ad 
The Bluetooth address types were not documented, causing warnings from
Doxygen.

Fixes zephyrproject-rtos#3524

Signed-off-by: Johan Hedberg <[email protected]>
@jhedberg jhedberg mentioned this issue Nov 5, 2018
Merged
@nashif
Copy link
Member

nashif commented Nov 5, 2018

@jhedberg thanks

nashif pushed a commit that referenced this issue Nov 6, 2018
@nashif
Bluetooth: Add basic documentation for address types
899d704 
The Bluetooth address types were not documented, causing warnings from
Doxygen.

Fixes #3524

Signed-off-by: Johan Hedberg <[email protected]>
nashif pushed a commit that referenced this issue Nov 13, 2018
@nashif
Bluetooth: Add basic documentation for address types
a9bf3a8 
The Bluetooth address types were not documented, causing warnings from
Doxygen.

Fixes #3524

Signed-off-by: Johan Hedberg <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jhedberg jhedberg

Labels
area: Bluetooth bug The issue is a bug, or the PR is fixing a bug priority: low Low impact/importance bug
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@nashif @jhedberg @zephyrbot