Skip to content

Commit

Permalink
add support for typescript-style docstrings
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
boneskull committed Nov 13, 2020
1 parent 025fc2e commit 6d3fe26
Show file tree
Hide file tree
Showing 3 changed files with 300 additions and 105 deletions.
2 changes: 1 addition & 1 deletion jsdoc.conf.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"tutorials": "docs/api-tutorials",
"verbose": true
},
"plugins": ["plugins/markdown"],
"plugins": ["./node_modules/jsdoc-ts-utils", "plugins/markdown"],
"source": {
"include": ["lib/", "./docs/API.md", "bin"]
},
Expand Down
Loading

0 comments on commit 6d3fe26

Please sign in to comment.