roxygen3 (version 0.1)

NameTag-class: @name: Override the default topic name.

Description

By default, the topic name is derived from the object following the roxygen comments. This tag is rarely needed and using it may suggest that you are documenting the wrong object.

Tag Usage

#' @name name

See Also

@rdname for modifying the generated file name and combining the documentation for multiple objects into one file.