tests/testthat/roxygen-example-1.R

In roxygen2: In-Line Documentation for R

##' Title
##'
##' Description
##'
##' Details
##'
##' @param x,y,z Descriptions for x, y, z
##' @param a Description of a
##' @param b
##'   Description of b
##' @section Important:
##' Don't run with scissors!
##' @export
NULL

##' Title
##'
##' Description
##'
##' Details
##'
##' @param x,y,z Descriptions for x, y, z
##' @param a Description of a
##' @param b
##'   Description of b
##' @section Important:
##' Don't run with scissors!
##' @export
NULL