R: Construct an 'rd_section' object

rd_section {roxygen2} | R Documentation

## Construct an `rd_section` object

### 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

    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.

[Package roxygen2 version 7.0.1 Index]