Auto-generated API documentation #377
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…rated API documentation
|
No production code touched, just documentation changes, will merge. |
This was referenced Oct 31, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 PR consolidates the double documentation in README and the code to one documentation base which is now auto-generated with the documentation tool. This should ease API documentation a lot and remove the current inconsistencies in documentation state.
For a starter the PR only transfers the current static documentation state from README to now being auto-generated (so coming from JSDOC comments) and doesn't improve on the documentation (with the exemption of some minor corrections).
This can be easily done in separate steps, PR just provides the ground for further work on the docs.