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": "" }