How to get Fires Tags defined type

[AdamSukma]

Search Terms

@fires tag type is removed when generating documentation

Problem

Currently I am want to define event that a component fires.

/**
 * Component demo.
 *
 * @fires {CustomEvent<{id: string, source: Element}>} item-click - event when item is clicked.
 */
export class ButtonControlElement extends LitElement {
}

and the result when it is generated is

I need for event type to be defined between {} since I also want to generate custom-element-manifest for my component https://github.com/webcomponents/custom-elements-manifest?tab=readme-ov-file

Expected Result:
{CustomEvent<{id: string, source: Element}>} is also printed in documentation

Suggested Solution

How do you suggest fixing the problem? Do any other tools already do it?

[Gerrit0]

TypeDoc does not preserve type annotations in JSDoc tags -- in general this results in significantly better documentation as JSDoc type annotations are redundant with types displayed elsewhere in the docs.

An option to preserve type annotations on a per-tag basis is a reasonable request.

[AdamSukma]

TypeDoc does not preserve type annotations in JSDoc tags -- in general this results in significantly better documentation as JSDoc type annotations are redundant with types displayed elsewhere in the docs.

An option to preserve type annotations on a per-tag basis is a reasonable request.

Currently I want to add custom theme to process the fires tag result. to a table with event name, type and its description. so It will be very helpful if there is an API to get fires tag type (and other custom tag) in DefaultThemeRenderContext

[Gerrit0]

There won't be a new function on there, that class is really intended as the API for replacing individual parts of the theme, not for utilities. It will be an additional property on the CommentTag class.