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 oslib #47

Merged
merged 1 commit into from
Sep 1, 2024
Merged

Document oslib #47

merged 1 commit into from
Sep 1, 2024

Conversation

dogo
Copy link
Owner

@dogo dogo commented Sep 1, 2024

PR Description:

This PR enhances the oslib.h header file by adding comprehensive Doxygen-style documentation. The updates include:

  • File Overview: Added a brief introduction to the file's purpose within OSLib.
  • Module Descriptions: Grouped related functions and variables under clear sections (general, sync, memory, maths, debug, misc).
  • Detailed Documentation:
    • Documented key variables, function pointers, and functions.
    • Added explanations for macros, particularly those related to memory management and benchmarking.
    • Clarified platform-specific differences between PSP and non-PSP environments.

Impact:

  • No functional changes.
  • Improved readability: The documentation provides clear guidance for developers, making the library easier to use and maintain.

This PR prepares the codebase for better developer onboarding and automated documentation generation.

@dogo dogo merged commit ea4e126 into master Sep 1, 2024
6 checks passed
@dogo dogo deleted the feature/doc-oslib branch September 1, 2024 02:11
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