modules (version 0.3.0)

modfun: Class modfun

Description

The constructor and a print method for the class 'modfun', a function in a module. The only purpose is to have a print method for ad-hoc documentation.

Usage

modfun(x)
## S3 method for class 'modfun':
print(x, ...)

Arguments

x

(function)

...

(ignored)

Examples

fun <- function() {
  ## This is documentation
  ## Triggered by '##'
  NULL
}

modfun(fun)