roxygen2 (version 2.0)

parse.name.description: Parse an element containing a mandatory name and description (such as @param).

Description

Parse an element containing a mandatory name and description (such as @param).

Usage

parse.name.description(key, rest)

Arguments

key

the parsing key

rest

the expression to be parsed

Value

• A list containing the key, name and description

See Also

Other preref parsing functions: parse.default, parse.name, parse.toggle, parse.unknown, parse.value