SCM

SCM Repository

[inlinedocs] Diff of /pkg/inlinedocs/man/extract.docs.setClass.Rd
ViewVC logotype

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 125, Thu Sep 16 09:34:38 2010 UTC revision 353, Mon Apr 9 12:44:43 2012 UTC
# Line 4  Line 4 
4  \description{Using the same conventions as for functions, definitions of S4 classes  \description{Using the same conventions as for functions, definitions of S4 classes
5  in the form \code{setClass("classname",\dots)} are also located and  in the form \code{setClass("classname",\dots)} are also located and
6  scanned for inline comments.}  scanned for inline comments.}
7  \usage{  \usage{extract.docs.setClass(doc.link)}
 extract.docs.setClass(doc.link)  
 }  
8  \arguments{  \arguments{
9    \item{doc.link}{DocLink object as created by \code{\link{extract.file.parse}}.    \item{doc.link}{DocLink object as created by \code{\link{extract.file.parse}}.
10  Note that \code{source} statements are \emph{ignored} when scanning for  Note that \code{source} statements are \emph{ignored} when scanning for
# Line 15  Line 13 
13  \details{Extraction of S4 class documentation is currently limited to expressions  \details{Extraction of S4 class documentation is currently limited to expressions
14  within the source code which have first line starting with  within the source code which have first line starting with
15  \code{setClass("classname"}. These are located from the source file  \code{setClass("classname"}. These are located from the source file
16  (allowing also for white space around the \code{setClass} and ).  (allowing also for white space around the \code{setClass} and \code{(}).
17  Note that \code{"classname"} must be a quoted character string;  Note that \code{"classname"} must be a quoted character string;
18  expressions returning such a string are not matched.  expressions returning such a string are not matched.
19    
20  For class definitions, the slots (elements of the  For class definitions, the slots (elements of the
21  \code{representation} list) fill the role of function  \code{representation} list) fill the role of function
22  arguments, so may be documented by  comments on  arguments, so may be documented by \code{##<<} comments on
23  the same line or  comments at the beginning of the  the same line or \code{### } comments at the beginning of the
24  following line.  following line.
25    
26    If there is no explicit title on the first line of setClass, then
27    one is made up from the class name.
28    
29  The class definition skeleton includes an \code{Objects from the Class}  The class definition skeleton includes an \code{Objects from the Class}
30  section, to which any \code{##details<<} documentation chunks are  section, to which any \code{##details<<} documentation chunks are
31  written. It is given a vanilla content if there are no specific  written. It is given a vanilla content if there are no specific
32  \code{##details<<} documentation chunks.}  \code{##details<<} documentation chunks.}
33    
34    
35  \author{Inlinedocs development team <inlinedocs-support@lists.r-forge.r-project.org>}  \author{Inlinedocs development team
36    <inlinedocs-support@lists.r-forge.r-project.org>}
37    
38    
39    

Legend:
Removed from v.125  
changed lines
  Added in v.353

root@r-forge.r-project.org
ViewVC Help
Powered by ViewVC 1.0.0  
Thanks to:
Vienna University of Economics and Business Powered By FusionForge