Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

function fields do not get documented #2436

Closed
teidesu opened this issue Nov 1, 2023 · 0 comments
Closed

function fields do not get documented #2436

teidesu opened this issue Nov 1, 2023 · 0 comments

Comments

@teidesu
Copy link

teidesu commented Nov 1, 2023

Search terms

when describing a function with fields using typescript const declarations, the fields are not getting documented:

/** The FOO function */
function foo() {
    return "foo";
}

function bugInner(): { foo: string } {
    return { foo: "bar" }
}

/**
 * The BUG function
 */
export const bug: {
    (): { foo: string }
    foo: typeof foo
    bar: 42
} = Object.assign(bugInner, {
    foo,
    bar: 42 as const,
});

Expected Behavior

fields get documented

Actual Behavior

fields are not documented, only the root function (bug) gets documented:
image

Steps to reproduce the bug

TypeStrong/typedoc-repros#34

Environment

  • Typedoc version: 0.25.3
  • TypeScript version: 5.2.2
  • Node.js version: 18.12.1
  • OS: macOS
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants