produceAllManualPagesFromObject {wyz.code.rdoc}

Produce All Manual Pages From Object

Description

Produce object and methods manual pages from an object.

Usage

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 \codeProcessingContext.

generationContext_o_1

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

packageName_s_1

a single string that is the target package name to consider for generation. Allows to generate automatically the author section content.

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 <[e-mail]>

Maintainer: Fabien Gelineau <[e-mail]>