summaryrefslogtreecommitdiffhomepage
path: root/jsdoc.conf.json
diff options
context:
space:
mode:
authorJo-Philipp Wich <jo@mein.io>2019-11-05 09:33:40 +0100
committerJo-Philipp Wich <jo@mein.io>2019-11-05 09:37:52 +0100
commit3942789dc62d6a0e7fcfb0a935bfe5c8d372245b (patch)
tree9ec432a1dc31c7d837575e7989a47d7cca93e86b /jsdoc.conf.json
parent9b92b2c8f9ce69cfe89c231311d37177ecaa8d43 (diff)
documentation: add JS api docs
Signed-off-by: Jo-Philipp Wich <jo@mein.io> (cherry picked from commit d9452d1157aef6b8752fac0f4ed1e0b9221abb31)
Diffstat (limited to 'jsdoc.conf.json')
-rw-r--r--jsdoc.conf.json22
1 files changed, 22 insertions, 0 deletions
diff --git a/jsdoc.conf.json b/jsdoc.conf.json
new file mode 100644
index 000000000..87a5b603f
--- /dev/null
+++ b/jsdoc.conf.json
@@ -0,0 +1,22 @@
+{
+ "tags": {
+ "allowUnknownTags": true,
+ "dictionaries": ["jsdoc","closure"]
+ },
+ "source": {
+ "include": ["modules/luci-base/htdocs/luci-static/resources"],
+ "includePattern": ".+\\.js(doc|x)?$"
+ },
+ "plugins": [
+ "plugins/markdown"
+ ],
+ "templates": {
+ "cleverLinks": true,
+ "monospaceLinks": true
+ },
+ "opts": {
+ "destination": "documentation/jsapi",
+ "recurse": true,
+ "readme": "README.md"
+ }
+}