ProcessingContext-class {wyz.code.rdoc}

Processing Context

Description

Environment class ProcessingContext. Defines and eases processing context management.

Usage

ProcessingContext(extraneous_l = list(), postProcessing_l = list())

Arguments

extraneous_l

An unconstrained named list. Each entry will be turned into a R documentation section.

postProcessing_l

An unconstrained named list. Each entry will trigger a post processing for the related R documentation section.

Details

If a post processing function returns NULL, related section will be removed from generated content. See examples below.

Post processing aims to put in action simple transformations, as changing letter cases, or applying simple beautifying technics. See beautify.

Value

An object instance of class ProcessingContext.

Information

Environment fields

◆ extraneous_l	list
◆ postProcessing_l	list
◆ self	environment

Environment methods

■ verifyExtraneous(extraneous_l)
■ verifyPostProcessing(postProcessing_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.

Author(s)

Fabien Gelineau <[e-mail]>

Maintainer: Fabien Gelineau <[e-mail]>

See Also

Class InputContext class GenerationContext class and class ManualPageBuilder.

Examples

pc <- ProcessingContext(
  extraneous_l = list(
    'my section' = "a special dedicace to neonira",
    keyword = 'documentation',
    concept = 'documentation generation'
  ),
  postProcessing_l = list(
    'my section' = function(content_s) {
       gsub('neonira', 'NEONIRA', content_s, fixed = TRUE)
    },
    author = function(content_s) { NULL } # destroy section
  )
)