roxydocs
In order to add documentation to {cpp11}
wrapper functions, generated using
cpp11::cpp_register(),
this experimental package adds a
{roxygen2} tag, @documents, which can be
used to specify one (or several) functions which are associated with an
existing block of documentation.
Mimicking the style of documentation where functions with explicit
@rdname tags are associated with a NULL-terminated dummy block as
#' Basic arithmetic
#'
#' @param a,b numeric vectors.
#' @name arith
NULL
#' @rdname arith
add <- function(a, b) a + b
#' @rdname arith
times <- function(a, b) a * bthe @documents tag attempts to create identical documentation without
having to rely on @rdname tags.
#' Basic arithmetic
#'
#' @param a,b numeric scalars.
#' @name arith
#' @documents add
#' @documents times
NULL
add <- function(a, b) a + b
times <- function(a, b) a * bDisclaimer
This is not intended for production use, but was only created for exploring options for documenting {cpp11} wrapper functions.