Remove insecure dependency and add promisified API to docs (#17)

milindl · web-flow · commit fa7901b0cd54 · 2023-12-15T23:24:45.000+05:30
diff --git a/Makefile b/Makefile
@@ -80,8 +80,8 @@ docs: node_modules/.dirstamp
 	@rm -rf docs
 	@./node_modules/jsdoc/jsdoc.js --destination docs \
 		--recurse -R ./README.md \
-		-t "./node_modules/toolkit-jsdoc/" \
-		--tutorials examples ./lib
+		-c ./jsdoc.conf \
+		--tutorials examples/ ./lib
 
 gh-pages: node_modules/.dirstamp
 	@./make_docs.sh
diff --git a/jsdoc.conf b/jsdoc.conf
@@ -0,0 +1,16 @@
+{
+    "plugins": [],
+    "recurseDepth": 10,
+    "source": {
+        "includePattern": ".+\\.js(doc|x)?$"
+    },
+    "sourceType": "module",
+    "tags": {
+        "allowUnknownTags": true,
+        "dictionaries": ["jsdoc","closure"]
+    },
+    "templates": {
+        "cleverLinks": false,
+        "monospaceLinks": false
+    }
+}
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -46,7 +46,6 @@
     "jshint": "^2.10.1",
     "mocha": "^10.2.0",
     "node-gyp": "^9.3.1",
-    "toolkit-jsdoc": "^1.0.0",
     "typescript": "^5.1.6"
   },
   "dependencies": {
