Interface comments are ignored

[ThibaultJanBeyer]

Unfortunately, I found another issue trying to generate documentation for my project:

Expected Behavior

When running typedocs over a class with interfaces in the constructor, I'd expect the comments to be displayed

Actual Behavior

No comments are displayed

Steps to reproduce the bug

Given:

interface Settings {
  /** some description */
  foo: string
}

class MyClass {
  constructor({ foo = 'bar' }: Settings) { ... }
}

The Typedocs output is

# constructor

    new MyClass(__namedParameters: { foo: string }): MyClass

     >   Defined in MyClass.ts:87

## Parameters
        __namedParameters: { foo: string }

           - foo: string

While the description is correctly displayed under the Settings Interface, in the Classes documentation it's not.
I'd either expect it to have the description from the interface taken over like:

- foo: string
some description

Or to have a reference to the interface something like this:

## Parameters
        __namedParameters: settings: Settings

 - settings: Settings

Environment

• Typedoc version: "typedoc": "^0.19.2",
• TypeScript version: "typescript": "^4.0.5"

[Gerrit0]

I believe this is a problem with typedoc-plugin-markdown - The default themes will render this as follows, with a link to the settings interface:

[ThibaultJanBeyer]

Thanks for your Answer @Gerrit0 but somehow, just using:

typedoc --out docs/ts --mode modules src

See:

[Gerrit0]

Oops... I checked on the 0.20 beta - this is another case of the bug linked in your other issue.

[ThibaultJanBeyer]

Ah! All right, any plans when 0.20 will be released? :D

[Gerrit0]

That highly depends on how many issues are discovered - The current set of remaining things to do isn't that large, so I might be able to get it done in another couple of weeks. #1364 tracks what's being done.

That said, I am publishing betas, which will likely produce better output already than 0.19 (but might not work correctly with plugins - I'm almost certain I broke the markdown plugin since TypeDoc now supports more literal types than just string literals)

[ThibaultJanBeyer]

All right, I don't really understand what you mean by the plugins but looking forward to the changes. Where can I get the beta releases?
Will close this issue then since it's addressed in the new version already as you say :)

[Gerrit0]

By plugins I mean packages like typedoc-plugin-markdown that add extra features to TypeDoc.

You can get betas with npm install typedoc@beta

[ThibaultJanBeyer]

Thank you, will try it out!