Merge pull request #1160 from kevinoid/silent-template

Create silent template
This commit is contained in:
Jeff Williams 2016-03-21 15:57:24 -07:00
commit a80431ab3c
2 changed files with 19 additions and 0 deletions

View File

@ -0,0 +1,11 @@
OVERVIEW
========
The `silent` template outputs nothing at all. Why would that be useful? Primarily for running JSDoc as a linter to check for syntax errors and unrecognized tags in documentation comments, although it may also be useful for testing or benchmarking purposes.
USAGE
=====
./jsdoc myscript.js -t templates/silent -a all --pedantic
This command exits with a non-zero exit code if any errors are encountered. It writes nothing to disk and the only output it produces is any error messages written to `stderr`. This command can also be used to warn about tags which are unknown to JSDoc by setting `"allowUnknownTags": false` in a configuration file.

View File

@ -0,0 +1,8 @@
'use strict';
/**
@param {TAFFY} taffyData See <http://taffydb.com/>.
@param {object} opts
@param {Tutorial} tutorials
*/
exports.publish = function(taffyData, opts, tutorials) {};