Skip to content

Commit e9b357f

Browse files
committed
Adding jsdoc.
1 parent ed11653 commit e9b357f

File tree

4 files changed

+250
-0
lines changed

4 files changed

+250
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
/ci/c8/
2+
/ci/jsdoc/
23
/node_modules/
34
/lib/**/*.js
45
/test/**/*.js

ci/jsdoc-conf.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"opts": {
3+
"destination": "./ci/jsdoc/",
4+
"recurse": true
5+
},
6+
"source": {
7+
"include": ["./lib/"]
8+
}
9+
}

package-lock.json

Lines changed: 236 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
"type": "module",
1111
"scripts": {
1212
"coverage": "c8 -c ./ci/c8.json npm run test",
13+
"jsdoc": "jsdoc -c ./ci/jsdoc-conf.json",
1314
"test": "mocha --config ./ci/mocha.json"
1415
},
1516
"dependencies": {
@@ -18,5 +19,8 @@
1819
"mocha": "^10.4.0",
1920
"n-readlines": "^1.0.1",
2021
"sinon": "^17.0.1"
22+
},
23+
"devDependencies": {
24+
"jsdoc": "^4.0.2"
2125
}
2226
}

0 commit comments

Comments
 (0)