wyz.code.rdoc (version 1.1.19)

GenerationContext-class: Generation Context

Description

Define a generation context to produce a manual page

Usage

GenerationContext(targetFolder_s_1 = tempdir(),
                  overwrite_b_1 = FALSE,
                  verbosity_b_1 = FALSE,
                  useMarkers_b_1 = FALSE
)

Arguments

targetFolder_s_1

a single string that is the target folder to store produced manual pages. Must exist.

overwrite_b_1

a single boolean value, allowing to overwrite an existing manual page.

verbosity_b_1

a single boolean verbosity flag. Turn on for interactive use. Keep off for programmatic usage.

useMarkers_b_1

A single boolean value, specifying if sections should be generated with special markers whenever possible.

Value

An object instance of class GenerationContext based on environment.

Information

Environment fields

overwrite_b_1	logical
self	environment
targetFolder_s_1	character
useMarkers_b_1	logical
verbosity_b_1	logical

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 class and class ManualPageBuilder.

Examples

# NOT RUN {
GenerationContext()

GenerationContext(overwrite = TRUE, verbosity = TRUE)
# }