Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Callable variables not getting written documentation #2008

Closed
limulus opened this issue Jul 19, 2022 · 0 comments
Closed

Callable variables not getting written documentation #2008

limulus opened this issue Jul 19, 2022 · 0 comments
Labels
bug Functionality does not match expectation

Comments

@limulus
Copy link

limulus commented Jul 19, 2022

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
@limulus limulus added the bug Functionality does not match expectation label Jul 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Functionality does not match expectation
Projects
None yet
Development

No branches or pull requests

1 participant