inlinedocs (version 2019.12.5)

prefixed.lines: prefixed lines

Description

The primary mechanism of inline documentation is via consecutive groups of lines matching the specified prefix regular expression "^### " (i.e. lines beginning with "### ") are collected as follows into documentation sections:

description

group starting at line 2 in the code

arguments

group following each function argument

value

group ending at the penultimate line of the code

These may be added to by use of the ##<< constructs described below.

Usage

prefixed.lines(src, ...)

Arguments

src

…

Examples

# NOT RUN {
test <- function
### the description
(x,
### the first argument
 y ##<< another argument
 ){
  5
### the return value
##seealso<< foobar
}
src <- getSource(test)
prefixed.lines(src)
extract.xxx.chunks(src)

# }