make_gtr_str_dmt_spine: Make getter setter documentation spine

In readyforwhatsnext/ready4fun: ready4 Function Authoring And Documentation Tools

Description

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

Usage

make_gtr_str_dmt_spine(
  fn_type_1L_chr,
  fn_name_1L_chr,
  class_name_1L_chr,
  doc_in_class_1L_lgl,
  example_1L_lgl = F
)

Arguments

fn_type_1L_chr	Function type (a character vector of length one)
fn_name_1L_chr	Function name (a character vector of length one)
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)
example_1L_lgl	Example (a logical vector of length one), Default: F

Value

Getter setter documentation spine (a list of character vectors)

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