Skip to main content

param_lines

Function param_lines 

Source
fn param_lines(parsed_impl: &ParsedImpl, params: &[(&str, &str)]) -> Vec<String>
Expand description

The @param lines of the field methods on the class page, without the names the constructor documents there: roxygen2 keeps the last @param of a name on a page, and these blocks must not replace the constructor’s text. An env class’s Class$new() lists its arguments in a \describe{} list, not as @param lines, so it takes nothing away. (The type’s standalone accessors, which documented x / value on the page named after the type, are internal under field syntax, #1900.)