SCM

SCM Repository

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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 396 - (view) (download) (as text)

1 : kmpont 213 \name{extract.docs.setClass}
2 :     \alias{extract.docs.setClass}
3 :     \title{S4 class inline documentation}
4 :     \description{Using the same conventions as for functions, definitions of S4 classes
5 :     in the form \code{setClass("classname",\dots)} are also located and
6 :     scanned for inline comments.}
7 : markus 396 \usage{extract.docs.setClass(doc.link)}\arguments{
8 : tdhock 356 \item{doc.link}{DocLink object as created by \code{extract.file.parse}.
9 : kmpont 213 Note that \code{source} statements are \emph{ignored} when scanning for
10 :     class definitions.}
11 :     }
12 :     \details{Extraction of S4 class documentation is currently limited to expressions
13 :     within the source code which have first line starting with
14 :     \code{setClass("classname"}. These are located from the source file
15 : tdhock 353 (allowing also for white space around the \code{setClass} and \code{(}).
16 : kmpont 213 Note that \code{"classname"} must be a quoted character string;
17 :     expressions returning such a string are not matched.
18 :    
19 :     For class definitions, the slots (elements of the
20 :     \code{representation} list) fill the role of function
21 : tdhock 353 arguments, so may be documented by \code{##<<} comments on
22 :     the same line or \code{### } comments at the beginning of the
23 : kmpont 213 following line.
24 :    
25 : kmpont 305 If there is no explicit title on the first line of setClass, then
26 :     one is made up from the class name.
27 :    
28 : kmpont 213 The class definition skeleton includes an \code{Objects from the Class}
29 :     section, to which any \code{##details<<} documentation chunks are
30 :     written. It is given a vanilla content if there are no specific
31 :     \code{##details<<} documentation chunks.}
32 :    
33 :    
34 : tdhock 392 \author{Toby Dylan Hocking <toby@sg.cs.titech.ac.jp> [aut, cre], Keith Ponting [aut], Thomas Wutzler [aut], Philippe Grosjean [aut], Markus Müller [aut], R Core Team [ctb, cph]}
35 : kmpont 213
36 :    
37 :    
38 :    
39 :    

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