S4 class inline documentation
Using the same conventions as for functions, definitions of S4 classes
in the form
setClass("classname",...) are also located and
scanned for inline comments.
DocLink object as created by
Extraction of S4 class documentation is currently limited to expressions
within the source code which have first line starting with
setClass("classname". These are located from the source file
(allowing also for white space around the
"classname" must be a quoted character string;
expressions returning such a string are not matched.
For class definitions, the slots (elements of the
representation list) fill the role of function
arguments, so may be documented by
##<< comments on
the same line or
### comments at the beginning of the
If there is no explicit title on the first line of setClass, then one is made up from the class name.
The class definition skeleton includes an
Objects from the Class
section, to which any
##details<< documentation chunks are
written. It is given a vanilla content if there are no specific
##details<< documentation chunks.
Toby Dylan Hocking <firstname.lastname@example.org> [aut, cre], Keith Ponting [aut], Thomas Wutzler [aut], Philippe Grosjean [aut], Markus Müller [aut], R Core Team [ctb, cph]
Want to suggest features or report bugs for rdrr.io? Use the GitHub issue tracker.