roxygen3 (version 0.1)

DocTypeTag-class: @docType: set the documentation type of the object.

Description

Roxygen3 will guess the doctype for you - the only time you should need to specify it yourself for package documentation (@docType package) which typically document the code NULL.

Arguments

Tag Usage

#' @docType data
#'  @docType package
#'  @docType custom doctype

Details

You can use any doctype, but it will only be included in the Rd file if it is one of the standard R doctypes: data, package, methods and class.