Document usb - #41
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 enhances the documentation for the
usb.hfile using Doxygen, ensuring comprehensive coverage of all elements, including functions, macros, and enums. The documentation now provides clear descriptions of the purpose, usage, and return values for each function, as well as detailed information on the USB state enum and theoslGetUsbStatemacro.Key Updates:
@filetag to provide a brief overview of theusb.hfile's purpose.oslInitUsbStorage,oslStartUsbStorage,oslStopUsbStorage, andoslDeinitUsbStorage) is now fully documented, with clear descriptions and return values.oslGetUsbStatemacro has been documented to clarify its function.@defgrouptag for better organization in the generated documentation.This update improves code readability and helps future developers understand the USB module's functions and usage more effectively.