Interface TemplateDocComments

The descriptions written into a template.

interface TemplateDocComments {
    Fields: readonly DocCommentEntry[];
    Parameters: readonly DocCommentEntry[];
    Summary: string | null;
}

Index

Properties

Fields Parameters Summary

Properties

`Readonly`Fields

Fields: readonly DocCommentEntry[]

@field descriptions and trailing --: descriptions, header entries first.

`Readonly`Parameters

Parameters: readonly DocCommentEntry[]

@param descriptions.

`Readonly`Summary

Summary: string | null

The text before the first tag of the first doc comment, or null.