SCM Repository

[inlinedocs] View of /pkg/inlinedocs/man/extract.docs.setClass.Rd
 [inlinedocs] / pkg / inlinedocs / man / extract.docs.setClass.Rd

View of /pkg/inlinedocs/man/extract.docs.setClass.Rd

Wed Mar 9 16:49:46 2011 UTC (8 years, 5 months ago) by kmpont
File size: 1496 byte(s)
Options fix just introduced now correctly restores original settings
\name{extract.docs.setClass}
\alias{extract.docs.setClass}
\title{S4 class inline documentation}
\description{Using the same conventions as for functions, definitions of S4 classes
in the form \code{setClass("classname",\dots)} are also located and
\usage{
}
\arguments{
Note that \code{source} statements are \emph{ignored} when scanning for
class definitions.}
}
\details{Extraction of S4 class documentation is currently limited to expressions
within the source code which have first line starting with
\code{setClass("classname"}. These are located from the source file
(allowing also for white space around the \code{setClass} and ).
Note that \code{"classname"} must be a quoted character string;
expressions returning such a string are not matched.

For class definitions, the slots (elements of the
\code{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
following line.

The class definition skeleton includes an \code{Objects from the Class}
section, to which any \code{##details<<} documentation chunks are
written. It is given a vanilla content if there are no specific
\code{##details<<} documentation chunks.}

\author{Inlinedocs development team <inlinedocs-support@lists.r-forge.r-project.org>}