typedreturn {roxytypes} | R Documentation |
roxygen2
@typedreturn
tag
Description
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.
[Package roxytypes version 0.1.1 Index]