make_fn_dmt_spine: Make function documentation spine

In readyforwhatsnext/ready4fun: ready4 Function Authoring And Documentation Tools

Description

make_fn_dmt_spine() is a Make function that creates a new R object. Specifically, this function implements an algorithm to make function documentation spine. The function returns Function documentation spine (a list of character vectors).

Usage

make_fn_dmt_spine(
  fn_name_1L_chr,
  fn_type_1L_chr,
  fn_title_1L_chr = NA_character_,
  fn,
  details_1L_chr = NA_character_,
  example_1L_lgl = F,
  export_1L_lgl = T,
  class_name_1L_chr,
  doc_in_class_1L_lgl
)

Arguments

fn_name_1L_chr	Function name (a character vector of length one)
fn_type_1L_chr	Function type (a character vector of length one)
fn_title_1L_chr	Function title (a character vector of length one), Default: 'NA'
fn	Function (a function)
details_1L_chr	Details (a character vector of length one), Default: 'NA'
example_1L_lgl	Example (a logical vector of length one), Default: F
export_1L_lgl	Export (a logical vector of length one), Default: T
class_name_1L_chr	Class name (a character vector of length one)
doc_in_class_1L_lgl	Document in class (a logical vector of length one)

Value

Function documentation spine (a list of character vectors)

readyforwhatsnext/ready4fun documentation built on Nov. 22, 2020, 9:28 p.m.