Skip to contents

roxygen2 @typedreturn tag

Source: R/tag_typedreturn.R
typedreturn.Rd

The @typedreturn tag introduces a syntax for defining return types as a roxygen2 tag.

Usage

#' @typedreturn <type>
#'   <description>

Details

There is one important syntactic features:

  • \n after the type to separate it from the description.