@group

Tag Kind: Block

The @group tag can be used to place several related API items under a common header when listed in a page's index. It may be specified multiple times to list a reflection under several headings.

Unlike the @category tag, reflections will be automatically placed under a header according to their kind if the @group tag is not specified. This tag can be used to simulate custom member types.

Example

/**
 * @groupDescription Events
 * Events are for...
 * @showGroups
 */
export class App extends EventEmitter {
    /**
     * @group Events
     */
    static readonly BEGIN = "begin";

    /**
     * The `@event` tag is equivalent to `@group Events`
     * @event
     */
    static readonly PARSE_OPTIONS = "parseOptions";

    /**
     * The `@eventProperty` tag is equivalent to `@group Events`
     * @eventProperty
     */
    static readonly END = "end";
}

Group Descriptions

The @groupDescription block tag can be used to provide additional context about a group of reflections. TypeDoc automatically groups reflections according to their TypeScript kind, but custom groups can be created with the @group tag.

The @groupDescription tag should be placed in the comment for the reflection which contains the group of child reflections.

The first line of the @groupDescription will be taken as the group name, and following lines will be used for the description.

Navigation Customization

Groups can be added to the navigation tree with the navigation.includeGroups option. This can be selectively enabled or disabled by specifying the @showGroups and @hideGroups modifier tags within the comment on the parent reflection.

See Also

Settings

On This Page

@group