make_lines_for_writing_dmtd_fn: Make lines for writing documented

In readyforwhatsnext/ready4class: Readyforwhatsnext Tools For Creating And Extending Classes.

Description

make_lines_for_writing_dmtd_fn() is a Make function that creates a new R object. Specifically, this function implements an algorithm to make lines for writing documented function. The function is called for its side effects and does not return a value.

Usage

make_lines_for_writing_dmtd_fn(
  fn_name_1L_chr,
  fn_body_1L_chr,
  fn_type_1L_chr,
  class_nm_1L_chr,
  class_desc_1L_chr,
  abbreviations_lup = NULL
)

Arguments

fn_name_1L_chr	Function name (a character vector of length one)
fn_body_1L_chr	Function body (a character vector of length one)
fn_type_1L_chr	Function type (a character vector of length one)
class_nm_1L_chr	Class name (a character vector of length one)
class_desc_1L_chr	Class description (a character vector of length one)
abbreviations_lup	Abbreviations (a lookup table), Default: NULL

readyforwhatsnext/ready4class documentation built on Nov. 14, 2020, 1:29 a.m.