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

Module-level summaries don't appear for all member kinds #2803

Closed
pjeby opened this issue Dec 7, 2024 · 1 comment
Closed

Module-level summaries don't appear for all member kinds #2803

pjeby opened this issue Dec 7, 2024 · 1 comment
Labels
bug Functionality does not match expectation

Comments

@pjeby
Copy link

pjeby commented Dec 7, 2024

Search terms

@summary, useFirstParagraphOfCommentAsSummary

Expected Behavior

As described in the @summary docs, when a function, type alias, or other module member has a @summary, or if useFirstParagraphOfCommentAsSummary is enabled, it should have a summary on the module page exporting that function.

Actual Behavior

Summaries appear for classes and interfaces but not standard function declarations, even if an explicit @summary is given. (They do appear for functions defined with const fn = () => {} however.)

Steps to reproduce the bug

Entry point:

/**
 * Text A
 * @summary Text B
 */
export function test() {
}

Module page lists test function but neither Text A nor Text B appear below, whether useFirstParagraphOfCommentAsSummary is used or not.

Environment

  • Typedoc version: 0.27.3
  • TypeScript version: 5.2.2
  • Node.js version: 18.20.2
  • OS: Windows 10
@pjeby pjeby added the bug Functionality does not match expectation label Dec 7, 2024
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Dec 8, 2024

It's incredible how even after living with the special case nightmare that is functions for as long as I have, I still manage to consistently forget to handle it...

@Gerrit0 Gerrit0 closed this as completed in 88b8f2b Dec 8, 2024
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

2 participants