extra.class.docs: Extract documentation from code chunks

Description Usage Arguments Value Author(s)

Description

Parse R code to extract inline documentation from comments around each class looking at the "source" attribute. This is a Parser Function that can be used in the parser list of package.skeleton.dx(). TODO:

Usage

1
extra.class.docs(code, objs, env, ...)

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)

...

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]



Search within the inlinedocs package
Search all R packages, documentation and source code

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.