produceAllManualPagesFromObject: Produce All Manual Pages From Object

Description Usage Arguments Classification Note Author(s)

View source: R/produceAllManualPagesFromObject.R

Description

Produce object and methods manual pages from an object.

Usage

1
2
3
4
produceAllManualPagesFromObject(object_o_1,
                                processingContext_o_1 = ProcessingContext(),
                                generationContext_o_1 = GenerationContext(),
                                packageName_s_1 = NA_character_)

Arguments

object_o_1

The single object you want to generate manual pages from.

processingContext_o_1

The processing context object to consider for generation. See ProcessingContext.

generationContext_o_1

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

packageName_s_1

The target package name to consider for generation. Allows to generate automatically the author section content.

Classification

STRATUM ▶ LAYER_3

PHASING ▶ RUN

INTENT ▶ QUALITY_CONTROL

Note

This is an EXPERIMENTAL function. Prefer usage of function produceManualPage instead.

It generates reliable individual manual pages that taken all together are not fully compatible with R way to express documentation.

In particular, expect duplicated aliases to appear, and some name weirdness also.

Author(s)

Fabien Gelineau <neonira@gmail.com>

Maintainer: Fabien Gelineau <neonira@gmail.com>


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