Skip to content

Callable variables not getting written documentation #2008

@limulus

Description

@limulus

Search terms

callable variable function factory

Expected Behavior

Callable variables should receive the documentation in the TSDoc block.

Actual Behavior

The written documentation is not included in the HTML output.

Steps to reproduce the bug

const makeFn = () => () => {}

/**
 * my-written-docs-here
 */
export const myFn = makeFn()

After running typedoc it should show my-written-docs-here in the comments, but does not. Here’s a repro PR: TypeStrong/typedoc-repros#15

Possibly a regression of #858?

Environment

  • Typedoc version: 0.23.8
  • TypeScript version: 4.7.4
  • Node.js version: 16.15.1
  • OS: macOS 12.4

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions