details (version 0.4.0)

foldstart: Roxygen2 Documentation Folding

Description

Insert more information to function documentation without overwhelming the user by using foldstart and foldend macros.

Usage

foldstart(title = NULL)
foldend()

Value

character

Arguments

title

Title of the folded section, Default: NULL

Details

To enable this feature add to the DESCRIPTION file before rendering the roxygen2:

Roxygen: list(markdown = TRUE)

Examples

# With title

 "#' \foldstart{This is an example}
 
  #' DOCUMENTATION
 
  #' \foldend"


# With no title

 "#' \foldstart{}
 
  #' DOCUMENTATION
 
  #' \foldend"