"Delegate" type aliases render summary in wrong location

[jonchardy]

Search terms

Type Alias
Delegate
Handler

Expected Behavior

The following type declaration should render with its comment just below the signature.

/**
 * The signature for a function acting as an event handler.
 */
export type EventHandler = ((e: Event) => void);

It should appear like this (without the | null, added to show expected output).

Actual Behavior

Typedoc renders the description as part of the type declaration.

Steps to reproduce the bug

Repro here:
TypeStrong/typedoc-repros#30

Environment

• Typedoc version: 0.24.8
• TypeScript version: 5.1.6
• Node.js version: 18.13.0
• OS: Windows 11

[Gerrit0]

This happens because @param tags in that comment should be attached to the function's parameters, so the entire comment is implicitly considered to belong to the function, which is a really unfortunate way of making that work...

[LennardF1989]

This happens because @param tags in that comment should be attached to the function's parameters, so the entire comment is implicitly considered to belong to the function, which is a really unfortunate way of making that work...

So is this fixable? Is there a workaround, even if draconic?

[Gerrit0]

/**
 * The signature for a function acting as an event handler.
 */
export type EventHandler = ((e: Event) => void) & {};

is the same type, but is not detected as a function signature, so kinda sorta works...

This should be fixable, unfortunately signature comment handling is really convoluted, likely not a trivial change.