typedoc2md / typedoc-plugin-markdown

A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.
https://typedoc-plugin-markdown.org
MIT License
725 stars 177 forks source link

Support table and htmlTable for return value #672

Closed xixixao closed 3 months ago

xixixao commented 3 months ago

What package is the feature request related to?

typedoc-plugin-markdown

Background

When the return value is an object with many fields, having the object be printed as a table would be way more readable. I'm not sure exactly what the solution should look like, since if the return value is a not an object it probably doesn't need a table. (and ofc there's only a single return value, so using a table for it is not as obvious as for parameters)

Proposed solution

No response

xixixao commented 3 months ago

Nah, I guess it's fine as is.