jsdoc-to-markdown icon indicating copy to clipboard operation
jsdoc-to-markdown copied to clipboard

Support for TypeScript types inside JsDoc?

Open timonson opened this issue 3 years ago • 5 comments
trafficstars

Is it somehow possible to convert JSDoc including the supported types by TypeScript?

For example:

/**
 * appendChild.
 * @param {Element} el
 * @return {(...nodesOrStrings: (Node|string)[]) => void}
 */
export function append(el) {
  return (...nodesOrStrings) => el.append(...nodesOrStrings);
}

I am getting the following error here:

JSDOC_ERROR: ERROR: Unable to parse a tag's type expression...

Thanks!

timonson avatar Jun 21 '22 01:06 timonson

Did you find a solution?

nicolas-tesla-x avatar Jun 24 '22 02:06 nicolas-tesla-x

No

timonson avatar Jun 24 '22 02:06 timonson

is typescript even supported ? I dont see anything that enables generating docs for typescript files in the documentation. can you show how you are running it ? for me it says "JSDOC_ERROR: There are no input files to process" when I run it for typescript files

gaurav-ingalkar avatar Jul 08 '22 12:07 gaurav-ingalkar

https://github.com/jsdoc2md/jsdoc-to-markdown/wiki/How-to-document-TypeScript

qqqiangqiang avatar Jul 29 '22 12:07 qqqiangqiang