Browse Source

Add jsdoc configuration and dependencies.

Maciej Gołaszewski 9 years ago
parent
commit
f8dd37ad4f
2 changed files with 24 additions and 0 deletions
  1. 22 0
      conf.json
  2. 2 0
      package.json

+ 22 - 0
conf.json

@@ -0,0 +1,22 @@
+{
+	"opts": {
+		"template": "./node_modules/jaguarjs-jsdoc",
+		"encoding": "utf8",
+		"destination": "out/jsdoc",
+		"recurse": true,
+		"access": "all"
+	},
+	"plugins": [
+		"plugins/markdown"
+	],
+	"source": {
+		"include": [
+			"dist/esnext"
+		],
+		"exclude": [
+			"dist/esnext/test"
+		],
+		"includePattern": ".+\\.js(doc)?$",
+		"excludePattern": "(^|\\/|\\\\)_"
+	}
+}

+ 2 - 0
package.json

@@ -40,6 +40,8 @@
     "guppy-pre-commit": "^0.3.0",
     "inquirer": "^0.11.0",
     "istanbul": "^0.4.1",
+    "jaguarjs-jsdoc": "0.0.1",
+    "jsdoc": "^3.4.0",
     "jshint": "^2.9.1",
     "jshint-reporter-jscs": "^0.1.0",
     "merge-stream": "^1.0.0",