Add jsoc to create documentation of JavaScript code.
Signed-Off-By: Piyush Vijay <piyushvijay.1997@gmail.com>
This commit is contained in:
parent
6f20ffdf64
commit
5240ca612d
30
.jsdoc.json
Normal file
30
.jsdoc.json
Normal file
@ -0,0 +1,30 @@
|
||||
{
|
||||
"tags": {
|
||||
"allowUnknownTags": true,
|
||||
"dictionaries": ["jsdoc", "closure"]
|
||||
},
|
||||
"recurseDepth": 10,
|
||||
"source": {
|
||||
"include": ["js/src/", "package.json"],
|
||||
"includePattern": ".js$",
|
||||
"exclude": ["js/src/plugins"],
|
||||
"excludePattern": "(node_modules/|docs)"
|
||||
},
|
||||
"sourceType": "module",
|
||||
"plugins": [
|
||||
"plugins/markdown"
|
||||
],
|
||||
"templates": {
|
||||
"cleverLinks": true,
|
||||
"monospaceLinks": true,
|
||||
"useLongnameInNav": false,
|
||||
"showInheritedInNav": true
|
||||
},
|
||||
"opts": {
|
||||
"destination": "./doc/js/",
|
||||
"encoding": "utf8",
|
||||
"private": true,
|
||||
"recurse": true,
|
||||
"template": "./node_modules/minami"
|
||||
}
|
||||
}
|
||||
@ -9,7 +9,8 @@
|
||||
"dev:wds": "webpack-dev-server --progress",
|
||||
"prod:build": "del js/lib js/dist && babel js/src/ -d js/lib --ignore .test.js && cross-env NODE_ENV=production webpack -p --env.production --progress",
|
||||
"lint:check": "eslint js/src/*.js",
|
||||
"lint:fix": "eslint js/src/*.js --fix"
|
||||
"lint:fix": "eslint js/src/*.js --fix",
|
||||
"generate-docs": "node_modules/.bin/jsdoc --configure .jsdoc.json --verbose"
|
||||
},
|
||||
"dependencies": {
|
||||
"codemirror": "5.37.0",
|
||||
@ -36,6 +37,8 @@
|
||||
"cross-env": "^5.1.5",
|
||||
"del-cli": "^1.1.0",
|
||||
"eslint": "^4.9.0",
|
||||
"jsdoc": "^3.5.5",
|
||||
"minami": "^1.2.3",
|
||||
"webpack": "^4.8.3",
|
||||
"webpack-bundle-analyzer": "^2.13.1",
|
||||
"webpack-cli": "^2.1.3",
|
||||
|
||||
Loading…
Reference in New Issue
Block a user