[Regression] Documentation for destructured object properties is not picked up.

[canonic-epicure]

Search terms

object destructuring, object properties

Description

This used to work in 0.17, but now it does not. For this setup, where the Sym1 and Sym2 a descructured properties of the object, the docs for them are not "picked up"

const api = () : {
    Sym1 : () => number,
    Sym2 : () => boolean
} => {
    return null
}

/**
 * Important constant
 */
export const {
    /**
     * Docs for Sym1
     */
    Sym1,

    /**
     * Docs for Sym2
     */
    Sym2
} = api()

Result is:

And if you run the command line as: npx typedoc index.ts --excludeNotDocumented, the result is empty:

Reproduce

To reproduce:

• Clone this repo: https://github.com/canonic-epicure/typedoc-repro-1756
• npm i && npx typedoc index.ts --out docs
• Check the content of the docs/index.html

[Gerrit0]

I think I'm going to punt this one to 0.23 as well, since fixing it without making a significant breaking API change involves a ridiculous amount of hackery. There's a couple additional problems here, with the one making this immediately difficult to fix being that TypeDoc's checks for "has a comment" isn't consistent with whether or not TypeDoc will actually find a comment.

[canonic-epicure]

Ok, cool, no rush, since its possible to workaround this one. It worked in 0.17, I guess need to check what approach was used there.

[Gerrit0]

In 0.17, I'm pretty sure it worked because comments were always added to the parent function reflection, and then inherited to the signatures. That changed nearly a year ago now to fix... something... which broke this.

[canonic-epicure]

I see. Worth pining with a test.