Merge pull request #227 from w3c/tripu/jsdoc

Add JSDoc and set up output
w3c · Aug 11, 2015 · 608c98a · 608c98a
2 parents a9f32db + b055ec0
commit 608c98a
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -20,3 +20,6 @@ NOTES.txt
 
 pubruleschecker
 scratch
+
+# JSDoc output
+doc/api/
diff --git a/package.json b/package.json
@@ -24,12 +24,14 @@
     "coveralls": "^2.11.2",
     "expect.js": "^0.3.1",
     "istanbul": "^0.3.17",
+    "jsdoc": "^3.3.2",
     "mocha": "^2.2.5",
     "nsp": "^1.0.3"
   },
   "scripts": {
     "coverage": "istanbul cover _mocha",
     "coveralls": "npm run coverage && cat ./coverage/lcov.info | coveralls",
+    "jsdoc": "jsdoc -a all -d doc/api/ -e utf8 -r app.js lib/ test/ tools/",
     "nsp": "nsp package",
     "start": "node app.js",
     "test": "mocha"