Skip to content

Commit 6d3fe26

Browse files
committed
add support for typescript-style docstrings
this change adds [jsdoc-ts-utils](https://npm.im/jsdoc-ts-utils), which I have had success using in [mrca](https://npm.im/mrca). it allows us to use the `import()` syntax to reference types in other modules, and other things that make working in a TS-language-server-enabled editor much nicer. it does not support _all_ of the stuff TS does, but at least helps. this should not change the API documentation output (at least until we start using the new supported features) Signed-off-by: Christopher Hiller <boneskull@boneskull.com>
1 parent 025fc2e commit 6d3fe26

File tree

3 files changed

+300
-105
lines changed

3 files changed

+300
-105
lines changed

jsdoc.conf.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"tutorials": "docs/api-tutorials",
1616
"verbose": true
1717
},
18-
"plugins": ["plugins/markdown"],
18+
"plugins": ["./node_modules/jsdoc-ts-utils", "plugins/markdown"],
1919
"source": {
2020
"include": ["lib/", "./docs/API.md", "bin"]
2121
},

0 commit comments

Comments
 (0)