wyz.code.rdoc (version 1.1.7)

generateDocumentationContent: Generate R documentation file.

Description

Generate a R documentation file from an offensive programming instrumented object.

Usage

generateDocumentationContent(targetFolder_s_1, kind_s_1, name_s_1,
                             object_o_1, packageName_s_1, extraneous_l = list(),
                             typeFactory_o_1 = FunctionParameterTypeFactory(),
                             overwrite_b_1 = FALSE)

Arguments

targetFolder_s_1

the target folder to write files to

kind_s_1

a single string taken amongst 'package', 'class', 'method'.

name_s_1

Either the package name, the class name or the method name, depending on previous argument.

object_o_1

an object of the given class

packageName_s_1

the name of the targeted package to produce documentation for

extraneous_l

a list of extraneous data, to consider when producing R documentation content.

typeFactory_o_1

a type factory object. See FunctionParameterTypeFactory

overwrite_b_1

a boolean, allowing file overwriting when file already exists.

Value

A list with two entries named filename and overwritten, expressing the filename and the overwritten boolean flag.

If a single file is produced, then a such list is returned, otherwise, a list of a such list is returned.

References

Refer to Writing R extensions to know more about R documentation requirements.

Examples

# NOT RUN {
# see system.file('inst/ut-generateDocumentationFiles.R', package = 'wyz.code.rdoc')
# for a complete example
# }