produceManualPage: Produce Manual Page
In neonira/wyz.code.rdoc: Wizardry Code Offensive Programming R Documentation

Description Usage Arguments Value Classification Author(s) Examples

Use this function to produce a manual page.

1
2
3

produceManualPage(inputContext_o_1,
                  processingContext_o_1 = ProcessingContext(),
                  generationContext_o_1 = GenerationContext())

`inputContext_o_1`	The input context object to consider for generation. See `InputContext`.
`processingContext_o_1`	The processing context object to consider for generation. See `ProcessingContext`.
`generationContext_o_1`	The generation context object to consider for generation. See `GenerationContext`.

A list holding generation process information.

Use function interpretResults to get knowledge of generated parts and remaining issues.

STRATUM ▶ LAYER_3

PHASING ▶ RUN

INTENT ▶ QUALITY_CONTROL

Fabien Gelineau <neonira@gmail.com>

Maintainer: Fabien Gelineau <neonira@gmail.com>

ic <- InputContext(NULL, 'append', packageName_s_1 = 'wyz.code.rdoc')

res <- produceManualPage(ic)
# WARNING: File /tmp/RtmpYIampA/append.Rd
# checkRd: (5) /tmp/RtmpYIampA/append.Rd:0-19: Must have a \description

interpretResults(res)
# filename is /tmp/RtmpYIampA/append.Rd [OVERWRITTEN]
# generated 8 sections: name, alias, title, usage, arguments, author, keyword, encoding
# missing 3 sections: description, value, examples
# probably missing 1 section: details