Implement API documentation using npm:documentation. #3323
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
Fixes #3138 Replaces and closes #3239 basically working Suite and utils work Runner and Suite datatypes work Hook extends Runnable - at least link in description hook is child of mocha and has error first solid pass Remove attempted module link from Hook to Runnable because of documentationjs/documentation#820 Switch API documenation to html output, link to them, include in site build Update TOC Bring lock file in sync with package.json Linting Update package-lock.json
boneskull
approved these changes
Apr 12, 2018
| * @public | ||
| * @class JSON | ||
| * @memberof Mocha.reporters | ||
| * @extends Mocha.reporters.Base | ||
| * @api public |
There was a problem hiding this comment.
You are welcome to remove @api public and @api private from everywhere if you wish.
boneskull
added
area: documentation
This was referenced Sep 22, 2018
Closed
Closed
This was referenced Oct 2, 2018
This was referenced Oct 25, 2018
This was referenced Nov 1, 2018
This was referenced Nov 19, 2018
This was referenced Dec 1, 2018
This was referenced Dec 8, 2018
This was referenced Dec 23, 2018
This was referenced Mar 14, 2020
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.
Auto generated API documentation using https://www.npmjs.com/package/documentation
This PR is a rebased and squashed version of #3239 by @dfberry
@boneskull's reservations about html generation and linting have been addressed
Fixes #3138
Replaces and closes #3239