rd_section: Construct an 'rd_section' object

Description Usage Arguments Methods

View source: R/field.R

Description

An rd_section represents an Rd command that can appear at the top-level of an Rd document, like \name{}, \title{}, \description{}, or \section{}.

Usage

1
rd_section(type, value)

Arguments

type

Section type. Stored in type field, and in class rd_section_{type}. To avoid namespace clashes between different extensions, this should include the package name.

value

Section data. Only used by format() and merge() methods.

Methods

If provide your own rd_section type, you'll also need to define a format.rd_section_{type} method that returns formatted Rd output. You may also need to provide a merge.rd_section_{type} method if two sections can not be combined with rd_section(x$type, c(x$value, y$value)). See vignette("extending") for more details.


roxygen2 documentation built on Sept. 8, 2021, 9:08 a.m.