rk.rkh.doc: Create RKWard help file skeleton

In rkward-community/rkwarddev: A Collection of Tools for RKWard Plugin Development

Create RKWard help file skeleton

Description

Create RKWard help file skeleton

Usage

rk.rkh.doc(
  summary = NULL,
  usage = NULL,
  sections = NULL,
  settings = NULL,
  related = NULL,
  technical = NULL,
  title = NULL,
  hints = TRUE,
  gen.info = TRUE
)

Arguments

summary	An object of class XiMpLe.node to be pasted as the <summary> section. See rk.rkh.summary for details.
usage	An object of class XiMpLe.node to be pasted as the <usage> section. See rk.rkh.usage for details.
sections	A (list of) objects of class XiMpLe.node to be pasted as <section> sections. See rk.rkh.section for details.
settings	An object of class XiMpLe.node to be pasted as the <settings> section. See rk.rkh.settings for details. Refer to rk.rkh.scan for a function to create this from an existing plugin XML file.
related	An object of class XiMpLe.node to be pasted as the <related> section. See rk.rkh.related for details.
technical	An object of class XiMpLe.node to be pasted as the <technical> section. See rk.rkh.technical for details.
title	An object of class XiMpLe.node to be pasted as the <title> section. See rk.rkh.title for details.
hints	Logical, if TRUE and you leave out optional entries (like technical=NULL), empty dummy sections will be added.
gen.info	Logical, if TRUE a comment note will be written into the document, that it was generated by rkwarddev and changes should be done to the script. You can also provide a character string naming the very rkwarddev script file that generates this help file, which will then also be added to the comment.

Value

An object of class XiMpLe.doc.

See Also

rk.rkh.summary, rk.rkh.usage, rk.rkh.settings, rk.rkh.scan, rk.rkh.related, rk.rkh.technical and the Introduction to Writing Plugins for RKWard

rkward-community/rkwarddev documentation built on May 9, 2022, 3:02 p.m.