wyz.code.rdoc (version 1.1.19)

ManualPageBuilder-class: Manual Page Builder

Description

Environment class ManualPageBuilder. Creates manual pages according to the given context.

Usage

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

Arguments

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.

Value

An object instance of class ManualPageBuilder.

Information

Environment fields

colorizer	list
generationContext_o_1	environment
inputContext_o_1	environment
processingContext_o_1	environment
self	environment
strategy	list

Environment methods

assembleManualPage(pieces_l) buildManualPage() documentContent() getStrategy interpretResults(result_l)

offensive programming - semantic naming

Class name compliance is TRUE.

offensive programming - function return types

Class owns no function return type instrumentation.

offensive programming - test case definitions

Class owns no test case definitions.

See Also

Class InputContext class ProcessingContext and class GenerationContext.

Examples

# NOT RUN {
ic <- InputContext(NULL, 'append', package = 'my.package.name')
m <- ManualPageBuilder(ic)
r <- m$buildManualPage()
interpretResults(r)
# }