Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is rebased on top of master and assumes, that you would rebase your
WebUSB
branch on top of15bc1eeb6
(master sha at the moment) before reviewing/accepting it. (The conflict with master inLUFA/Drivers/USB/Class/Common/HIDReportData.h
is pretty trivial, you just need to change//@}
to/**@}*/
)The "
make -C Maintenance upgrade-doxygen (WebUSB Demo)
" commit updates thedoxyfile
to match the changes made in abcminiuser@6c9c7d5The 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
.The reason, why Doxygen couldn't find the reference to
WebUSB_URL_Descriptor_t
is because it didn't expand theATTR_PACKED
macro, so it thought that the type name isATTR_PACKED
, notWebUSB_URL_Descriptor_t
. I've updated thedoxyfile
optionPREDEFINED
so that the macro gets expanded.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).