Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #530
This implements API documentation for VexFlow. It's not adding any new
prose - only converting existing comments to JSDoc-style comments,
moving certain comments to position them correctly.
Adds one new dependency:
Adds two new npm run scripts:
Adds documentation output: API.md
Note that my time commitment here needs to stay pretty low: I have a
full-time job, significant side projects, and ongoing open source
commitments, so I don't have the bandwidth to get to 100% documentation
coverage or anything like that.
But I think this PR as it stands is enough for new contributors to jump in,
add more documentation, and find more old-fashioned comments that can just be
converted to JSDoc and start showing up in the docs.