From d0500a9730d60a7b94c23a81d4eed3e7bfbbf5fe Mon Sep 17 00:00:00 2001
From: "luk.lu" <luk.lu@faronear.org>
Date: Mon, 7 Jun 2021 10:50:13 +0800
Subject: [PATCH] =?UTF-8?q?=E7=AE=80=E5=8C=96=20jsdoc=20=E7=9B=B8=E5=85=B3?=
 =?UTF-8?q?=E8=AE=BE=E7=BD=AE?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .gitignore   | 2 ++
 index.js     | 1 +
 package.json | 6 ++----
 3 files changed, 5 insertions(+), 4 deletions(-)

diff --git a/.gitignore b/.gitignore
index d7e9ceb..580d5c4 100644
--- a/.gitignore
+++ b/.gitignore
@@ -6,3 +6,5 @@ package-lock.json
 ~*
 .gitattributes
 dump.rdb
+# jsdoc 的输出目录
+out/
\ No newline at end of file
diff --git a/index.js b/index.js
index fe7e3e4..6368909 100644
--- a/index.js
+++ b/index.js
@@ -1376,4 +1376,5 @@ class TICrypto {
   }
 }
 
+// 必须单独写 module.exports，不要和类定义写在一起，否则会导致 jsdoc 解析不到类内文档。
 module.exports = TICrypto
diff --git a/package.json b/package.json
index aa38aed..16f254f 100644
--- a/package.json
+++ b/package.json
@@ -15,12 +15,10 @@
   },
   "devDependencies": {
     "docdash": "^1.2.0",
-    "jaguarjs-jsdoc": "^1.1.0",
-    "jsdoc": "^3.6.6",
-    "minami": "^1.2.3"
+    "jsdoc": "^3.6.6"
   },
   "scripts": {
-    "setup": "npm install"
+    "doc": "jsdoc ./index.js -t node_modules/docdash --verbose"
   },
   "author": ""
 }