Make object documentation less verbose

[norswap]

What package is the feature request related to?

typedoc-plugin-markdown

Background

I have an exported variable that is a deeply nested const object.

Using "expandObjects": true, I get a very pleasant code representation of my object in the docs.

However, every property gets listed in a way that is very noisy (every property gets its own title and section, as well as every sub-property, etc etc).

Example: https://happychain.pages.dev/react/api/variables/chains#type-declaration

Proposed solution

An option that lets us choose between

• the current behaviour
• not rendering documentation (sections) for any property
• only rendering documentation (sections) for properties that have their own docstring

[tgreyuk]

Thank you. This does seem like a reasonable suggestion and will have a look at including some kind of configuration around this.

[tgreyuk]

@norswap I have been having a look at this. One thing I am exploring is simply replacing the entire "Type declaration" section with the source from the ts compiler exposed by the option typeDeclarationFormat: "source".

In your use-case you would see something like this:

Would you find this kind of solution satisfactory?

[norswap]

Yes, that seems perfect :)