archive-gh-me/jsdoc
1
0
Fork 0
mirror of https://github.com/jsdoc/jsdoc.git synced 2025-12-08 19:46:11 +00:00
Code Issues Projects Releases Wiki Activity
jsdoc/templates/silent
History
Jeff Williams aa0b6c1bfa switch to new-ish ECMAScript syntax 
With help from Lebab, plus a lot of manual cleanup. (And more cleanup to come, I'm sure.)
2019-01-15 18:39:10 -08:00
..
publish.js
switch to new-ish ECMAScript syntax
2019-01-15 18:39:10 -08:00
README.md
Create silent template
2016-02-24 14:28:53 -08:00

README.md

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.