search

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
689 stars 172 forks source link

Duplication in callback/callable/function properties. #581

Closed Shakeskeyboarde closed 2 months ago

Shakeskeyboarde commented 4 months ago

Properties that have a function type, include a "Type Declaration" section that I would like to omit. Even though it's a function value, it's first and foremost a property, and I want it to appear the same as other non-function valued properties.

I've attached a screenshot illustrating what I mean. The dir property has no duplication. The getDependencyLinks property shows the function signature and description twice, as well as "Parameters" and "Returns" subsections which I think are unnecessary. If I wanted to have detailed documentation about the function type, I would declare it as a type alias, instead of having it inlined.

Screenshot 2024-02-24 at 6 47 01 PM
tgreyuk commented 4 months ago

Thank you. This has actually already been fixed in typedoc-plugin-markdown@next . Will leave this issue open though until v4 is released (not sure the fix will make it into v3).

tgreyuk commented 2 months ago

typedoc-plugin-markdown@4.0.0