You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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 */exportfunctiontest(){}
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
The text was updated successfully, but these errors were encountered:
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...
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 ifuseFirstParagraphOfCommentAsSummary
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 withconst fn = () => {}
however.)Steps to reproduce the bug
Entry point:
Module page lists
test
function but neitherText A
norText B
appear below, whetheruseFirstParagraphOfCommentAsSummary
is used or not.Environment
The text was updated successfully, but these errors were encountered: