Skip to content

Commit 448c26d

Browse files
committed
Start migrating the doc comments to JSDoc
1 parent a282454 commit 448c26d

File tree

3 files changed

+161
-1
lines changed

3 files changed

+161
-1
lines changed

.jsdoc.config.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"plugins": [
3+
"plugins/markdown"
4+
],
5+
"source": {
6+
"include": [
7+
"src/api.js"
8+
]
9+
}
10+
}

package-lock.json

Lines changed: 148 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: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@
2727
"test-asm-debug": "node test/all.js asm-debug",
2828
"test-asm-memory-growth": "node test/all.js asm-memory-growth",
2929
"test-wasm": "node test/all.js wasm",
30-
"test-wasm-debug": "node test/all.js wasm-debug"
30+
"test-wasm-debug": "node test/all.js wasm-debug",
31+
"doc": "jsdoc -c .jsdoc.config.json"
3132
},
3233
"homepage": "http://github.com/kripken/sql.js",
3334
"repository": {
@@ -41,6 +42,7 @@
4142
"eslint": "^6.8.0",
4243
"eslint-config-airbnb-base": "^14.0.0",
4344
"eslint-plugin-import": "^2.20.1",
45+
"jsdoc": "^3.6.3",
4446
"node-fetch": "^2.6.0",
4547
"puppeteer": "^2.1.1",
4648
"test": ">=0.6"

0 commit comments

Comments
 (0)