Jsdoc is installed locally ( npm install jsdoc ). I get the following error while trying to execute
.\node_modules.bin\jsdoc --debug ./lib/JavaScriptSource.js
Output:
DEBUG: JSDoc 3.3.0-dev (Sun, 15 Jun 2014 18:39:52 GMT)
DEBUG: Environment info: {"env":{"conf":{"tags":{"allowUnknownTags":true},"templ
ates":{"monospaceLinks":false,"cleverLinks":false,"default":{"outputSourceFiles"
:true}},"source":{"includePattern":".+\.js(doc)?$","excludePattern":"(^|\/|\\
)_"},"plugins":[]},"opts":{"_":["./lib/JavaScriptSource.js"],"debug":true,"destina
tion":"./out/","encoding":"utf8"}}}
There are no input files to process.
JSDoc 3.3.0-dev (Sun, 15 Jun 2014 18:39:52 GMT) Options: -t, --template <value> The path to the template to use. Default: path/to/jsdoc/templates/default -c, --configure <value> The path to the configuration file. Default: path/to/jsdoc/conf.json ..... </code>
Turns is an open bug in jsdoc where it does not process filepath's starting with "_". github.com/jsdoc3/jsdoc/issues/308. Provides the solution as well.
Where the default excludePattern (^|/|\)_ ignores paths starting with an underscore.
The solution quoted from https://github.com/jsdoc3/jsdoc/issues/308
"To change the default behavior:
Copy conf.json.EXAMPLE to a new file, conf.json. You can put it in the JSDoc directory or another directory. If you put it in another directory, you will need to use the -c option to tell JSDoc where to find it: jsdoc -c path/to/conf.json Open conf.json in a text editor. Find the source.excludePattern property, and change it to an empty string."
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With