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
691 stars 171 forks source link

[typedoc-plugin-markdown@next] Unnecessary newlines @see @link #513

Closed CoderIllusionist closed 5 months ago

CoderIllusionist commented 7 months ago

Hi,

We define a property for our component like so;

    /**
     * The message to display when the input does not have an entered `value`, but is required.
     * @see {@link PwcInputHintMessage}
     * @deprecated Will be removed in version 7.x.
     * User `message.required` instead.
     */
    @Prop() requiredMessage?: string;

This is rendered like so: image

Maybe make it like so (remove the unnecessary newline for @see); image

Edit this also happens with for example @defaultValue

tgreyuk commented 7 months ago

Thanks - I think this is quite subjective. The html theme also places all tags as headings on own line. Could perhaps reduce the space, but again the spacing could be a preference for some. Will have to think about this one.

CoderIllusionist commented 7 months ago

It's indeed a personal thing, maybe create a option --linkInline ? if you'd want me to, I could create a PR for this