mirror of
https://github.com/jsdoc/jsdoc.git
synced 2025-12-08 19:46:11 +00:00
feat(jsdoc): remove "silent" template
I believe that `jsdoc file.js -X 1>/dev/null` accomplishes the same goal.
This commit is contained in:
parent
7475387f71
commit
8d7ad67df0
@ -1,9 +0,0 @@
|
||||
# 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.
|
||||
@ -1,21 +0,0 @@
|
||||
/*
|
||||
Copyright 2013 the JSDoc Authors.
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
https://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
*/
|
||||
/* eslint-disable no-empty-function, no-unused-vars */
|
||||
/**
|
||||
@param {TAFFY} taffyData See <http://taffydb.com/>.
|
||||
@param {object} opts
|
||||
*/
|
||||
exports.publish = (taffyData, opts) => {};
|
||||
Loading…
x
Reference in New Issue
Block a user