Description Details Tag Usage Slots
Many S4 slots are considered internal implementation details, so slots
(unlike params) are not documented by default. You can use the @slot
and @autoSlots
tags to document them. An example of the output is
include below.
If a name but no description is provided for @slot
, the description
will just contain a link to the documentation for the type of object that
goes in that slot. This is what is used for all slots if you use
@autoSlots
.
1 2 3 | #' @slot name
#' @slot name description
#' @autoSlots
|
An object of class character
An object of class character
An object of class character
An object of class srcref (S3)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.