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.
This adds automatically generated docs for our code using jsdoc style function comments. Function names, descriptions, params, param types, and return types are automatically grabbed with the option of manually adding more info.
I wasn't able to get search working but I believe that can be fixed after this gets merged and hosted online. At least that was my plan, was to host these docs using github pages.
I put the auto generated docs in the
docs/api
folder instead of the defaultdocs
folder that way we have somewhere to put our other docs like the DEVGUIDE. api might not be the best folder name but I couldn't think of a better name.Changes
npm run docs
DEVGUIDE.md
todocs/
docs/api