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

Document usb #41

Merged
merged 1 commit into from
Sep 1, 2024
Merged

Document usb #41

merged 1 commit into from
Sep 1, 2024

Conversation

dogo
Copy link
Owner

@dogo dogo commented Sep 1, 2024

This PR enhances the documentation for the usb.h file 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 the oslGetUsbState macro.

Key Updates:

  • File Overview: Added a @file tag to provide a brief overview of the usb.h file's purpose.
  • Function Documentation: Each USB function (oslInitUsbStorage, oslStartUsbStorage, oslStopUsbStorage, and oslDeinitUsbStorage) is now fully documented, with clear descriptions and return values.
  • Enum Documentation: Documented the USB state enum, explaining the different possible states of the USB connection.
  • Macro Documentation: The oslGetUsbState macro has been documented to clarify its function.
  • Grouping: Grouped all USB-related functions under the "Usb" module using the @defgroup tag 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.

@dogo dogo merged commit 00a223e into master Sep 1, 2024
6 checks passed
@dogo dogo deleted the feature/doc-usb branch September 1, 2024 00:20
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.

1 participant