as_roxygen_docs {options} | R Documentation |
Generate Standalone ?options
Documentation
Description
Produce a comprehensive documentation page outlining all your defined options' behaviors.
Usage
as_roxygen_docs(
title = paste(pkgname(env), "Options"),
desc = default_options_rd_desc(),
env = parent.frame()
)
Arguments
title |
An optional, customized title (defaults to "Options") |
desc |
An optional, customized description of behaviors |
env |
An environemnt in which to find the associated options object |
Value
A character vector of roxygen2
tag segments
See Also
Other options_roxygen2:
as_params()
Examples
#' @eval options::as_roxygen_docs()
NULL
[Package options version 0.2.0 Index]