DocLink-class

DocLink

The <code>.DocLink</code> class provides the basis for hooking together
documentation of related classes/functions/objects. The aim is that
documentation sections missing from the child are inherited from
the parent class.

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 

DocLink-class function

Objects can be created by calls of the form <code>new(DocLink ...)</code>

Objects from the Class

<dl class="dl-horizontal">
 <dt><code>name</code>:</dt><dd>(<code>character</code>) name of object</dd>
 <dt><code>created</code>:</dt><dd>(<code>character</code>) how created</dd>
 <dt><code>parent</code>:</dt><dd>(<code>character</code>) parent class or NA</dd>
 <dt><code>code</code>:</dt><dd>(<code>character</code>) actual source lines</dd>
 <dt><code>description</code>:</dt><dd>(<code>character</code>) preceding description block</dd>
 </dl>

Slots

No methods defined with class "DocLink" in the signature.

Methods

Link documentation among related functions — DocLink-class

<dl class='dl-horizontal'>
 <dt><code>name</code>:</dt><dd>(<code>character</code>) name of object</dd>
 <dt><code>created</code>:</dt><dd>(<code>character</code>) how created</dd>
 <dt><code>parent</code>:</dt><dd>(<code>character</code>) parent class or NA</dd>
 <dt><code>code</code>:</dt><dd>(<code>character</code>) actual source lines</dd>
 <dt><code>description</code>:</dt><dd>(<code>character</code>) preceding description block</dd>
 </dl>

DocLink-class: Link documentation among related functions

Description

Arguments

Objects from the Class

Slots

Methods