Callable variables use signature comment instead of variable comment

[VorontsovMaxim]

Search terms

Callable variable object property

Expected Behavior

Written callable variable documentation should be included in the HTML output.

Actual Behavior

Written callable variable documentation is not included in the HTML output.

Steps to reproduce the bug

const obj = {
    /** function-docs */
    fn(x: unknown) {}
}

/**
 * exported-docs
 * @param x param-docs
 */
export const bug = obj.fn;

Only function-docs string is included in the HTML output, but not exported-docs string, neither as param-docs string.

But when you remove docs of function declaration exported-docs and param-docs appears in the HTML output.

const obj = {
    fn(x: unknown) {}
}

/**
 * exported-docs
 * @param x param-docs
 */
export const bug = obj.fn;

Here's repro PR: TypeStrong/typedoc-repros#20

Environment

• Typedoc version: 0.23.11
• TypeScript version: 4.8.2
• Node.js version: 16.17.0
• OS: macOS 12.4

[Gerrit0]

Hmm... this is going to be an annoying one to fix, because fixing this could easily break other usages where pulling the comment from the signature is expected.

[VorontsovMaxim]

We haven't control over obj because it's autogenerated, but still want to document exported functions. So maybe there are some workarounds to get desired behaviour?

Also i just found one more similar problem with factory functions:

function factory() {
    /** function-docs */
    function fn() {};

    return fn;
}

/** exported-docs */
export const bug = factory();