Block: [DEV] Block class.

In hadley/roxygen3: In-source documentation for R

Description

This function is aimed primarily at developers extending this package. You shouldn't need to use it for everyday operation.

The block class encapsulates the data about a single roxygen comment block, along with its location in the src code, and the object associated with the block.

Usage

  Block(tags = list(), object = new("NullObject"),
    srcref = new("NullSrcref"), default_tags = base_tags())

Arguments

tags	a list of Tag objects
object	the documented object, of class Object
srcref	a srcref giving the location of the block
default_tags	a character vector giving the names of the classes that should be used to add default tags to the class.

hadley/roxygen3 documentation built on May 17, 2019, 12:16 p.m.