usb subsystem doc not pulling from header doxygen comments #5702
Assignees
Labels
area: Documentation
area: USB
Universal Serial Bus
bug
The issue is a bug, or the PR is fixing a bug
priority: low
Low impact/importance bug
Comments
finikorg
added a commit
to finikorg/zephyr
that referenced
this issue
Sep 11, 2018
Fixes issue with USB subsystem doc not pulling from header doxygen comments of USB Device Controller code. Fixes: zephyrproject-rtos#5702 Signed-off-by: Andrei Emeltchenko <[email protected]>
finikorg
added a commit
to finikorg/zephyr
that referenced
this issue
Sep 11, 2018
Instead of documenting in rst, pull the API from USB Device Core Layer header. Fixes: zephyrproject-rtos#5702 Signed-off-by: Andrei Emeltchenko <[email protected]>
nashif
pushed a commit
that referenced
this issue
Sep 11, 2018
Instead of documenting in rst, pull the API from USB Device Core Layer header. Fixes: #5702 Signed-off-by: Andrei Emeltchenko <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The usb subsystem documentation in
doc/subsystem/usb/usb.rsthas API information directly in the.rstfile instead of pulling from the doxygen comments (creating an opportunity for doc and header APIs getting out of sync). Doxygen comments need to include a group that can be pulled into the.rstfile as is done for Shell API functions indoc/subsystems/shell.rst, for example.The text was updated successfully, but these errors were encountered: