extra method docs

Description

can be used in the parser list of package.skeleton.dx(). TODO:

Usage

1
2
extra.method.docs(code, objs, env, inlinedocs.exampleDir, inlinedocs.exampleTrunk, 
    ...)

Arguments

code

Code lines in a character vector containing multiple R objects to parse for documentation.

objs

The objects defined in the code.

env

The environment they inhibit (needed to pass on)

inlinedocs.exampleDir

A string pointing to the location where inlinedocs should search for external examples

inlinedocs.exampleTrunk

A string used to identify the files containing external examples in the example directory. All file names of external examples have to start with this string

...

ignored

Value

named list of lists, one for each object to document.

Author(s)

Toby Dylan Hocking <toby@sg.cs.titech.ac.jp> [aut, cre], Keith Ponting [aut], Thomas Wutzler [aut], Philippe Grosjean [aut], Markus Müller [aut], R Core Team [ctb, cph]

Want to suggest features or report bugs for rdrr.io? Use the GitHub issue tracker.