InputContext-class: Input Context

Description Usage Arguments Value Information Classification Author(s) See Also Examples

Description

Environment class InputContext. Defines and eases input context management.

Usage

1
2
3
4
5
InputContext(object_o_1,
             methodName_s_1 = NA_character_,
             packageName_s_1 = NA_character_,
             dataFilename_s_1 = NA_character_
)

Arguments

object_o_1

The object to consider, or NULL

methodName_s_1

A single string value that is the method name to consider

packageName_s_1

The target package name to use

dataFilename_s_1

A single string that is the data file name

Value

An object instance of class InputContext.

Information

Environment fields

beautifier list
class_kind character
class_name character
data_name NULL
dataFilename_s_1 character
file_name character
hack_description logical
instrumentationLevel list
kind double
kinds character
methodName_s_1 character
number_replacements integer
object_o_1 list
packageName_s_1 character
self environment
typeFactory_o_1 environment
use_markers logical

Environment methods

buildMethodName
generateConditionalMarker
generateConditionalMarkerGenerator
getFilename
getKind
getName
markerGenerator
produceAlias
produceArguments
produceAuthor
produceConcept
produceCustom_section
produceDescription
produceDetails
produceDocType
produceEncoding
produceExamples
produceFormat
produceKeyword
produceName
produceNote
produceRdOpts
produceRdversion
produceReferences
produceSeealso
produceSexpr
produceSource
produceSynopsis
produceTitle
produceUsage
produceValue
retrieveStrategy
setUseMarkers

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.

Classification

STRATUM ▶ CORE

PHASING ▶ BUILD

INTENT ▶ CONTENT_GENERATION

Author(s)

Fabien Gelineau <neonira@gmail.com>

Maintainer: Fabien Gelineau <neonira@gmail.com>

See Also

Class ProcessingContext class GenerationContext and class ManualPageBuilder.

Examples

1
2
3
ic1 <- InputContext(NULL)

ic2 <- InputContext(NULL, 'append', package = 'my.package.name')

neonira/wyz.code.rdoc documentation built on Feb. 19, 2020, 12:47 p.m.