Interface RoxygenBlock

A roxygen comment block, consisting of multiple roxygen tags.

interface RoxygenBlock {
    attachedTo?: NodeId;
    range?: [
        startLine: number,
        startColumn: number,
        endLine: number,
        endColumn: number,
        f?: string,
    ];
    requestNode: NodeId;
    tags: readonly RoxygenTag[];
    type: "roxygen-block";
}

Properties

attachedTo? range? requestNode tags type

Properties

Optional ReadonlyattachedTo

attachedTo?: NodeId

The AST node ID of the R node this roxygen block is attached to, if any (this comment may be a parent of the requested)

Optional Readonlyrange

range?: [
    startLine: number,
    startColumn: number,
    endLine: number,
    endColumn: number,
    f?: string,
]

The source location of the entire roxygen block, if available.

ReadonlyrequestNode

requestNode: NodeId

The ast node to which we assign the comment

Readonlytags

tags: readonly RoxygenTag[]

The roxygen tags contained in this block.

Readonlytype

type: "roxygen-block"

Settings

Member Visibility

On This Page

Properties