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

Fix doxygen #1

Merged
merged 0 commits into from
Aug 17, 2021
Merged

Fix doxygen #1

merged 0 commits into from
Aug 17, 2021

Conversation

RuRo
Copy link

@RuRo RuRo commented Aug 17, 2021

This PR is rebased on top of master and assumes, that you would rebase your WebUSB branch on top of 15bc1eeb6 (master sha at the moment) before reviewing/accepting it. (The conflict with master in LUFA/Drivers/USB/Class/Common/HIDReportData.h is pretty trivial, you just need to change //@} to /**@}*/)

  1. The "make -C Maintenance upgrade-doxygen (WebUSB Demo)" commit updates the doxyfile to match the changes made in abcminiuser@6c9c7d5

  2. The reason, why Doxygen couldn't find the reference to BOS_DESCRIPTOR is that the documentation for the Demos is completely separate from the Core library documentation. I don't think there is an easy way to cross-reference separate documentation sources in doxygen and other Demos don't seem to use \ref when referring to library types. So I decided to just remove this \ref.

  3. The reason, why Doxygen couldn't find the reference to WebUSB_URL_Descriptor_t is because it didn't expand the ATTR_PACKED macro, so it thought that the type name is ATTR_PACKED, not WebUSB_URL_Descriptor_t. I've updated the doxyfile option PREDEFINED so that the macro gets expanded.

  4. There was also an issue with the docs for the code you changed in LUFA/Drivers/USB/Core/StdDescriptors.h. I've added \code/\endcode markers there. Otherwise, doxygen thinks that this is plain text and "#define" is a reference (which doesn't exist).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants