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

Fix #2630: Add jsdoc style documentation #4066

Merged
merged 2 commits into from
Nov 21, 2024
Merged

Conversation

retrogtx
Copy link
Contributor

Add comprehensive JSDoc documentation to API classes

Changes Made

  • Added detailed JSDoc documentation to all methods in PitchBlocksAPI class
  • Added detailed JSDoc documentation to all methods in RhythmBlocksAPI class
  • Every method now includes:
    • A clear description of its purpose
    • @param tags with types and descriptions
    • @returns tags with types and descriptions

@walterbender walterbender merged commit eadd178 into sugarlabs:master Nov 21, 2024
3 checks passed
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.

2 participants