add jsdoc config.

This commit is contained in:
Christopher Jeffrey 2016-04-15 06:50:21 -07:00
parent 72e907f81e
commit e18763793a
No known key found for this signature in database
GPG Key ID: 8962AB9DE6666BBD
2 changed files with 30 additions and 0 deletions

6
.npmignore Normal file
View File

@ -0,0 +1,6 @@
.git*
test/
node_modules/
.jshintrc
.jscsrc
jsdoc.json

24
jsdoc.json Normal file
View File

@ -0,0 +1,24 @@
{
"tags": {
"allowUnknownTags": true
},
"source": {
"include": ["README.md", "lib/"],
"exclude": [],
"includePattern": ".+\\.js(doc)?$",
"excludePattern": "(^|\\/|\\\\)_"
},
"plugins": ["plugins/markdown"],
"templates": {
"cleverLinks": false,
"monospaceLinks": false
},
"opts": {
"template": "templates/default",
"encoding": "utf8",
"destination": "./docs/",
"recurse": true,
"private": true,
"pedantic": true
}
}