AutoSlotsTag-class

SlotTag-class


Many S4 slots are considered internal implementation details, so slots
(unlike params) are not documented by default. You can use the <code>@slot</code>
and <code>@autoSlots</code> tags to document them. An example of the output is
include below.


classes

A Doxygen-like in-source documentation system
for Rd, collation, and NAMESPACE.  (This is the third rewrite)

Hadley Wickham

roxygen3

In-source documentation for R

SlotTag-class function

<pre>
#' @slot name
#'  @slot name description
#'  @autoSlots
</pre>

Tag Usage

<dl>
  <dt>slots</dt><dd>An object of class character</dd> <dt>classname</dt><dd>An object of class character</dd> <dt>text</dt><dd>An object of class character</dd> <dt>srcref</dt><dd>An object of class srcref (S3)</dd> </dl> 

SlotTag-class: @slot: document the slots of a S4 class.

Description

Arguments

Tag Usage

Slots

Details