Skip to content

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

@pjeby

Description

@pjeby

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

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