mirror of
https://github.com/jsdoc/jsdoc.git
synced 2025-12-08 19:46:11 +00:00
Merge pull request #1160 from kevinoid/silent-template
Create silent template
This commit is contained in:
commit
a80431ab3c
11
templates/silent/README.md
Normal file
11
templates/silent/README.md
Normal 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.
|
||||
8
templates/silent/publish.js
Normal file
8
templates/silent/publish.js
Normal 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) {};
|
||||
Loading…
x
Reference in New Issue
Block a user