tsdoc
tsdoc copied to clipboard
microsoft
A doc comment standard for TypeScript
Closes #138 This PR adds the ability for tsdoc to parse XML elements. For example the following input: ``` /* * * This is a destructive operation. * */ ```...
Hello, I can't find any documentation on adding tsdocs to a typescript string literal type. I was wondering if the following is possible: ```ts type InputType = /** the TSDoc...
Markdown table or HTML table element can't be rendered correctly in TSDoc playground
Please support triple slashes Triple slash documentation is much cleaner in my opinion. E.g. Dart also supports it: https://www.dartlang.org/guides/language/effective-dart/documentation#do-use--doc-comments-to-document-members-and-types
In issue https://github.com/Microsoft/tsdoc/issues/27#issuecomment-473178150 , @sindresorhus asked: > How about documenting default function parameters? What will that look like? I've opened a new issue since I think it's a separate topic...
This builds on #324 to support parsing the new DeclarationReference format in TSDoc.
I'm currently working with d.ts files where methods taking object parameters are documented with the following approach: ```typescript /** * Method description. * @param options addItemOptions - e.g. { id:...
This adds a number of utility methods to various pieces of `DeclarationReference` to make it easier to make changes. NOTE: API for `from()` and `with()` is inspired by the Temporal...