Basic apidocs #8170
Merged
Basic apidocs #8170
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
fredj
reviewed
May 9, 2018
| @@ -1,36 +1,34 @@ | |||
| { | |||
| "opts": { | |||
| "recurse": true, | |||
| "template": "config/jsdoc/api/template" | |||
There was a problem hiding this comment.
does it mean that the config/jsdoc/api/template directory can be removed or will it be used in a second step?
There was a problem hiding this comment.
In the medium term we‘ll probably remove it. Leaving it here for now for testing/comparison reasons.
fredj
approved these changes
May 9, 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 pull request brings back basic API documentation. It just touches the JSDoc config, not the template. We'll probably be using a tool that generates the final docs from a JSON, so we'll use the JSON template instead.
One thing that will probably need some additional attention is how we document events, so we can get rid of the events plugin. I'll handle that in a separate pull request.