aboutsummaryrefslogtreecommitdiffstats
path: root/development/tools/.jsdoc.json
diff options
context:
space:
mode:
authorDan Finlay <dan@danfinlay.com>2018-04-13 05:39:28 +0800
committerDan Finlay <dan@danfinlay.com>2018-04-13 05:46:05 +0800
commit136caa2034e151763347d20488f2516277631bc9 (patch)
tree0b8d09b0f9003092611b37acf48ffc67e718cbd8 /development/tools/.jsdoc.json
parent29dab1e9e00c1c1e6ad834026df51b2839d3171d (diff)
downloadtangerine-wallet-browser-136caa2034e151763347d20488f2516277631bc9.tar.gz
tangerine-wallet-browser-136caa2034e151763347d20488f2516277631bc9.tar.zst
tangerine-wallet-browser-136caa2034e151763347d20488f2516277631bc9.zip
Add JSDocs Page and Script
Includes new script `npm run doc` for generating docs page.
Diffstat (limited to 'development/tools/.jsdoc.json')
-rw-r--r--development/tools/.jsdoc.json25
1 files changed, 25 insertions, 0 deletions
diff --git a/development/tools/.jsdoc.json b/development/tools/.jsdoc.json
new file mode 100644
index 000000000..fd90bf89f
--- /dev/null
+++ b/development/tools/.jsdoc.json
@@ -0,0 +1,25 @@
+{
+ "tags": {
+ "allowUnknownTags": false
+ },
+ "source": {
+ "include": "app/scripts/",
+ "includePattern": ".js$",
+ "excludePattern": "(node_modules/|docs)"
+ },
+ "plugins": [
+ "plugins/markdown"
+ ],
+ "opts": {
+ "template": "node_modules/radgrad-jsdoc-template/",
+ "encoding": "utf8",
+ "destination": "docs/jsdocs",
+ "recurse": true,
+ "verbose": true
+ },
+ "templates": {
+ "cleverLinks": false,
+ "monospaceLinks": false
+ }
+}
+