extra.code.docs

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

code

The objects defined in the <code>code</code>.

objs

&#8230;

Parse R <code>code</code> to extract inline documentation from comments around
each function. These are not able to be retreived simply by
looking at the "source" attribute. This is a Parser Function that
can be used in the parser list of package.skeleton.dx(). TODO:
Modularize this into separate Parsers Functions for S4 classes,
prefixes, ##&lt;&lt;blocks, etc. Right now it is not very clean!

Generates Rd files from R source code with comments.
The main features of the default syntax are that
(1) docs are defined in comments near the relevant code,
(2) function argument names are not repeated in comments, and
(3) examples are defined in R code, not comments.
It is also easy to define a new syntax.

Toby Hocking

inlinedocs

Convert Inline Comments to Documentation

Toby Dylan Hocking

Keith Ponting

Thomas Wutzler

Philippe Grosjean

Markus M<c3><bc>ller

R Core Team 

extra.code.docs function

Extract documentation from code chunks — extra.code.docs

Extract documentation from code chunks

extra.code.docs: Extract documentation from code chunks

Description

Usage

Arguments

Value