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

Update Audio Management Documentation for OSLib #28

Merged
merged 1 commit into from
Aug 31, 2024
Merged

Conversation

dogo
Copy link
Owner

@dogo dogo commented Aug 31, 2024

Description:

This PR enhances the documentation for OSLib's audio management functions, improving clarity and consistency to aid developers.

Key Updates:

  1. Detailed Descriptions: Added comprehensive explanations for functions and variables related to audio management.
  2. Documentation Structure: Organized content into relevant groups (audio_adv and audio), and streamlined descriptions by removing non-essential example code.
  3. Doxygen Compliance: Ensured all documentation comments are Doxygen-compatible for better integration into automated doc generation.

Impact:
These documentation improvements facilitate easier understanding and usage of OSLib's audio features, supporting better maintenance and development efficiency.

@dogo dogo merged commit 3f8641d into master Aug 31, 2024
6 checks passed
@dogo dogo deleted the feature/doc-audio branch August 31, 2024 22:47
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