Add support for jsdoc config file path inclusion in task config #8
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.
The following patch adds an additional, optional property
config
to the task config which allows the user to include a JSDoc config file path:Example:
A JSDoc config file can be used to allow markdown in JSDoc tags, see the Use JSDoc: How To Use the Markdown Plugin page for more information.
Sample JSDoc Configuration
The sample is heavily based on jsdoc's conf.json.EXAMPLE and uses the GitHub Flavored Markdown parser plugin.