Interface RoxygenBlock

A roxygen comment block, consisting of multiple roxygen tags.

interface RoxygenBlock {
    attachedTo?: NodeId;
    range?: readonly [Line, Column, Line, Column, string | undefined];
    requestNode: NodeId;
    tags: readonly RoxygenTag[];
    type: "roxygen-block";
}

Index

Properties

attachedTo? range? requestNode tags type

Properties

`Optional` `Readonly`attachedTo

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` `Readonly`range

range?: readonly [Line, Column, Line, Column, string | undefined]

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

`Readonly`requestNode

requestNode: NodeId

The ast node to which we assign the comment

`Readonly`tags

tags: readonly RoxygenTag[]

The roxygen tags contained in this block.

`Readonly`type

type: "roxygen-block"