return_roclet {roxytest}

Roclet: check presence of ⁠@return⁠ in documentation for exported functions

Description

This roclet checks presence of ⁠@return⁠ that generates ⁠\value⁠ in Rd files.

Generally you will not call this function directly but will instead use roxygen2::roxygenise() specifying this roclet.

Usage

return_roclet()

Value

A roclet to be used e.g. with roxygen2::roxygenise()

See Also

Other roclets: testthat_roclet, tinytest_roclet, param_roclet, examples_roclet, namespace_roclet, rd_roclet, vignette_roclet.

Other roclets: examples_roclet(), param_roclet(), testthat_roclet(), tinytest_roclet()

Examples

x <- "#' Summing two numbers\n#'\n#' @export\nf <- function(x, y) {\n   x + y\n}\n"
cat(x)
roxygen2::roc_proc_text(return_roclet(), x)