Skip to content

Comments

[API]: Refactor and document the public API#14

Merged
nircoe merged 1 commit intomainfrom
nircoe/main/api_documentation
Aug 31, 2025
Merged

[API]: Refactor and document the public API#14
nircoe merged 1 commit intomainfrom
nircoe/main/api_documentation

Conversation

@nircoe
Copy link
Owner

@nircoe nircoe commented Aug 31, 2025

  • Separate soundcoe.hpp declarations from soundcoe.cpp implementations
  • Add complete docstring documentation for all public API methods
  • Enable private OpenAL linking instead of public dependency exposure
  • Change bulk operations (pauseAll*, etc.) from bool to void with assertions
  • Make the methods non-static to allow proper header/source separation

@nircoe nircoe self-assigned this Aug 31, 2025
@nircoe nircoe marked this pull request as ready for review August 31, 2025 22:32
@nircoe nircoe merged commit 49cf8bf into main Aug 31, 2025
8 checks passed
@nircoe nircoe deleted the nircoe/main/api_documentation branch August 31, 2025 22:33
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