Skip to content

Document oslib - #47

Merged
dogo merged 1 commit into
masterfrom
feature/doc-oslib
Sep 1, 2024
Merged

Document oslib#47
dogo merged 1 commit into
masterfrom
feature/doc-oslib

Conversation

@dogo

@dogo dogo commented Sep 1, 2024

Copy link
Copy Markdown
Owner

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
@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