aboutsummaryrefslogtreecommitdiff
path: root/package.json
diff options
context:
space:
mode:
authorTobias Witt <[email protected]>2016-03-02 15:21:54 +0100
committerMarak <[email protected]>2016-03-03 04:30:38 -0500
commit90a6a04f9cd4a134fec20949e68beb4baf79bfae (patch)
tree70ada7191ace4c22e7d6a5ffa4a65a92d65c92a9 /package.json
parent9bb2b7c341bcf41e00341c92a8a66620c401c85f (diff)
downloadfaker-90a6a04f9cd4a134fec20949e68beb4baf79bfae.tar.xz
faker-90a6a04f9cd4a134fec20949e68beb4baf79bfae.zip
Install jsdoc and add doclet stubs for all methods
Descriptions are taken from existing comments if available. The address module already has some new sample descriptions.
Diffstat (limited to 'package.json')
-rw-r--r--package.json4
1 files changed, 3 insertions, 1 deletions
diff --git a/package.json b/package.json
index e18a7533..9093e1e7 100644
--- a/package.json
+++ b/package.json
@@ -13,7 +13,8 @@
"scripts": {
"lint": "node_modules/.bin/jshint ./lib --config ./.jshintrc",
"test": "node_modules/.bin/mocha test/*.*.js",
- "build": "cd build && ../node_modules/.bin/gulp && cd ../"
+ "build": "cd build && ../node_modules/.bin/gulp && cd ../",
+ "doc": "jsdoc -c conf.json -t ./node_modules/ink-docstrap/template -R README.md lib"
},
"devDependencies": {
"browserify": "5.11.1",
@@ -21,6 +22,7 @@
"gulp-mustache": "0.4.0",
"gulp-rename": "1.2.0",
"gulp-uglify": "1.0.1",
+ "jsdoc": "^3.4.0",
"jshint": "0.9.0",
"lodash": "^2.4.1",
"mocha": "1.8.x",