Description Usage Arguments Value Information Classification Note Author(s) See Also Examples
Environment class ManualPageBuilder. Creates manual pages according to the given context.
1 2 3 | ManualPageBuilder(inputContext_o_1,
processingContext_o_1 = ProcessingContext(),
generationContext_o_1 = GenerationContext())
|
inputContext_o_1 |
The input context object to consider for generation.
See |
processingContext_o_1 |
The processing context object to consider for generation.
See |
generationContext_o_1 |
The generation context object to consider for generation.
See |
An object instance of class ManualPageBuilder
.
colorizer list
◆ generationContext_o_1 environment
◆ inputContext_o_1 environment
◆ processingContext_o_1 environment
◆ self environment
◆ strategy list
assembleManualPage
■ buildManualPage
■ documentContent
■ getStrategy
■ interpretResults
Class name compliance is TRUE
.
Class owns no function return type instrumentation.
Class owns no test case definitions.
mpb <- ManualPageBuilder(inputContext_o_1, processingContext_o_1 = ProcessingContext(), generationContext_o_1 = GenerationContext())
STRATUM ▶ CORE
PHASING ▶ BUILD
INTENT ▶ PARTS_ASSEMBLY
As an end-user, you may prefer to use function produceManualPage
as its usage is
much more straightforward.
As a programmer, this class eases programmation of your own manual page builder. See examples below.
Fabien Gelineau <neonira@gmail.com>
Maintainer: Fabien Gelineau <neonira@gmail.com>
Class InputContext
class ProcessingContext
and
class GenerationContext
.
1 2 3 4 | ic <- InputContext(NULL, 'append', package = 'my.package.name')
m <- ManualPageBuilder(ic)
r <- m$buildManualPage()
interpretResults(r)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.