wyz.code.rdoc (version 1.1.19)

produceDocumentationFile: Produce Documentation File

Description

Use this function to save documentation text into a documentation file.

Usage

produceDocumentationFile(filename_s_1, content_s, generationContext_o_1)

Arguments

filename_s_1

the target file name to use

content_s

An unconstrained vector of string values

generationContext_o_1

The generation context object to consider for generation. See GenerationContext.

Classification

STRATUM LAYER_1

PHASING BUILD

INTENT CONTENT_GENERATION

Examples

# NOT RUN {
fn <- tempfile()
p <- produceDocumentationFile(basename(fn), c(
  generateSection('name', 'alpha'),
  generateSection('alias', 'alpha'),
  generateSection('keyword', 'documentation generation')
),
GenerationContext(dirname(fn)))

p
# $filename
# [1] "/tmp/RtmpSWZq4H/filee3c2700207f.Rd"
#
# $overwritten
# [1] TRUE

readLines(p$filename)
# [1] "\name{alpha}" "\alias{alpha}" "\keyword{documentation generation}"

# }