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 SSP descriptor documentation #1545

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

fabiensanglard
Copy link

Sorry about the extra =. This was an oversight.

Copy link
Member

@Youw Youw left a comment

Choose a reason for hiding this comment

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

LGTM

@mcuee mcuee added the Misc Whitespace, typo, coding style, etc label Aug 3, 2024
@tormodvolden
Copy link
Contributor

I'll copy what I wrote in #1429 (comment), with updated comments:

Doxygen warnings (seen when running make -C doc) caused by this commit:

libusb/descriptor.c:1012: warning: Compound internal_ssplus_capability_descriptor is not documented.
Maybe it needs to be moved? EDIT: Last resort would be masking it with doxygen @cond conditionals. Any other suggestions?

libusb/libusb.h:1077: warning: unable to resolve reference to 'libusb_ssplus_usb_device_capability_descriptor.numSublinkSpeedAttributes=' for \ref command
Caused by the trailing =. What was the intention with those =? EDIT: FIXED

libusb/descriptor.c:1013: warning: Member bLength (variable) of struct internal_ssplus_capability_descriptor is not documented.
libusb/descriptor.c:1014: warning: Member bDescriptorType (variable) of struct internal_ssplus_capability_descriptor is not documented.
libusb/descriptor.c:1015: warning: Member bDevCapabilityType (variable) of struct internal_ssplus_capability_descriptor is not documented.
libusb/descriptor.c:1016: warning: Member bReserved (variable) of struct internal_ssplus_capability_descriptor is not documented.
libusb/descriptor.c:1017: warning: Member bmAttributes (variable) of struct internal_ssplus_capability_descriptor is not documented.
libusb/descriptor.c:1018: warning: Member wFunctionalitySupport (variable) of struct internal_ssplus_capability_descriptor is not documented.
libusb/descriptor.c:1019: warning: Member wReserved (variable) of struct internal_ssplus_capability_descriptor is not documented.

Should they be added? EDIT: Related to first point, probably one solution for all.

libusb/libusb.h:1077: warning: unable to resolve reference to 'libusb_ssplus_usb_device_capability_descriptor.numSublinkSpeedAttributes=' for \ref command

Caused by the trailing = . EDIT: FIXED

@tormodvolden
Copy link
Contributor

Please see the commit I added for the @cond@ alternative. Also any other doxygen fans out there, I would be glad if someone can suggest a prettier way to do it. I know you can prepend \internal to the tag, but then you still need to document all the members.

See also my draft PR #1549 where I investigate adding doxygen validation to the CI.

@fabiensanglard
Copy link
Author

fabiensanglard commented Aug 11, 2024

Thank you for fixing this :), I am still ramping up on Doxygene !

I'll be more thorough in my next contribution.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Misc Whitespace, typo, coding style, etc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants