aboutsummaryrefslogtreecommitdiffstats
path: root/lang/js/jsdoc.conf
diff options
context:
space:
mode:
authorMaximilian Krambach <[email protected]>2018-07-04 11:38:54 +0000
committerMaximilian Krambach <[email protected]>2018-07-04 11:38:54 +0000
commit1919fa41b6da4dfd4f69e776caa6e6b1883eb208 (patch)
tree1650ffd04145a4c4f6246d3cda2557ce2bc5f53c /lang/js/jsdoc.conf
parentjs: add Key lookup (diff)
downloadgpgme-1919fa41b6da4dfd4f69e776caa6e6b1883eb208.tar.gz
gpgme-1919fa41b6da4dfd4f69e776caa6e6b1883eb208.zip
js: Add jsdoc, update webpack-cli dependency
-- * package.json: - the old webpack-cli version depended on two packages with vulnerabilities, set to minimum version 3.0.8 to fix this (nodesecurity.io/advisories/157, nodesecurity.io/advisories/612) - added License identifier * README: Updated documentation * jsdoc.conf: Added a configuration file for jsdoc * some minor documentation changes, indentations
Diffstat (limited to 'lang/js/jsdoc.conf')
-rw-r--r--lang/js/jsdoc.conf24
1 files changed, 24 insertions, 0 deletions
diff --git a/lang/js/jsdoc.conf b/lang/js/jsdoc.conf
new file mode 100644
index 00000000..12ae35e9
--- /dev/null
+++ b/lang/js/jsdoc.conf
@@ -0,0 +1,24 @@
+{
+ "tags": {
+ "allowUnknownTags": false,
+ "dictionaries": ["jsdoc"]
+ },
+ "source": {
+ "include": ["./src"],
+ "includePattern": ".+\\.js(doc|x)?$",
+ "excludePattern": "(^|\\/|\\\\)_"
+ },
+ "opts":{
+ "destination": "./doc/",
+ "recurse": true
+ },
+ "sourceType": "module",
+ "plugins": [],
+ "templates": {
+ "cleverLinks": false,
+ "monospaceLinks": false,
+ "default": {
+ "outputSourceFiles": true
+ }
+ }
+} \ No newline at end of file