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

More explicitly split for getter/setter APIs #701

Closed linrongbin16 closed 1 month ago

linrongbin16 commented 1 month ago

What package is the feature request related to?

typedoc-plugin-markdown

Background

hi, when generating markdown documents, I found the getter/setter APIs are not split in a very clear looking.

For example, in below docs, the wrap attribute actually has two APIs, getter and setter:

image

If user doesn't pay attention for them, they will probably ignore the setter API:

image

Proposed solution

No response

linrongbin16 commented 1 month ago

One more thing is: it will put the @returns at the end of this attribute, which looks more like the returned value for the setter API.

image

I feel like if we add two headers Getter and Setter under the wrap accessor, it will look much more clear.

linrongbin16 commented 1 month ago

The doc site is here: https://rsvim.github.io/docs/next/api/rsvim/classes/RsvimOpt