Interface DocCommentEntry

One described parameter or field.

interface DocCommentEntry {
    DeclaredType: string | null;
    Description: string;
    Name: string;
    NameSpan: Span;
    Source: DocCommentSource;
    Span: Span;
}

Index

Properties

DeclaredType Description Name NameSpan Source Span

Properties

`Readonly`DeclaredType

DeclaredType: string | null

The {type} written after the tag, such as string, or null.

`Readonly`Description

Description: string

`Readonly`Name

Name: string

`Readonly`NameSpan

NameSpan: Span

`Readonly`Source

Source: DocCommentSource

`Readonly`Span

Span: Span

The tag line or trailing comment.