Interface JSDocStructure

interface JSDocStructure {
    description?: string | WriterFunction;
    kind: JSDoc;
    leadingTrivia?: string | WriterFunction | (string | WriterFunction)[];
    tags?: OptionalKind<JSDocTagStructure>[];
    trailingTrivia?: string | WriterFunction | (string | WriterFunction)[];
}

Hierarchy (View Summary)

Structure
JSDocSpecificStructure
- JSDocStructure

Index

Properties

description? kind leadingTrivia? tags? trailingTrivia?

Properties

`Optional`description

description?: string | WriterFunction

The description of the JS doc.

Remarks

To force this to be multi-line, add a newline to the front of the string.

kind

kind: JSDoc

`Optional`leadingTrivia

leadingTrivia?: string | WriterFunction | (string | WriterFunction)[]

Leading comments or whitespace.

`Optional`tags

tags?: OptionalKind<JSDocTagStructure>[]

JS doc tags (ex. @param value - Some description.).

`Optional`trailingTrivia

trailingTrivia?: string | WriterFunction | (string | WriterFunction)[]

Trailing comments or whitespace.