genDocumentation: Generate documentation for the programmatically generated...

In omegahat/RGCCTUFFI: Programmatically generate interfaces to C routines and data structures that are accessed dynamically via Rffi

Description

This function and the collection of (as yet) unexported helper functions create documentation for the functions, classes and enumeration constants and classes that we generate in this package corresponding to native routines and data structures. The function generates the content that can be put in Rd files as part of a package for documenting the generated code.

Usage

genDocumentation(funcs, types, enums, paramDocs = list())

Arguments

funcs	the list of resolved function descriptions computed from the translation unit. By resolved, we mean returned by a call to RGCCTranslationUnit's resolveType function.
types	the list of resolved data types
enums	the list of resolved enumerations.
paramDocs	an optional list with named elements corresponding to the names of functions in funcs. Each element should be a character vector (or list with each element being a character string or vector). These strings are used to document specific parameters in that function. If a parameter for a function has an entry in this two-tier list, that string is used as the documentation. Otherwise, the default content is used which describes the expected type.

Value

An object of class RTUDocumentation. This has 3 slots - for classes, functions and enums.

Author(s)

Duncan Temple Lang

References

Writing R extensions manual The RGCCTranslationUnit package

See Also

genTUInterface

omegahat/RGCCTUFFI documentation built on May 24, 2019, 1:53 p.m.