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 109 - (view) (download) (as text)

1 : tdhock 90 \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 :     \usage{
8 :     extract.docs.setClass(doc.link)
9 :     }
10 :     \arguments{
11 : tdhock 91 \item{doc.link}{DocLink object as created by \code{\link{extract.file.parse}}.
12 :     Note that \code{source} statements are \emph{ignored} when scanning for
13 :     class definitions.}
14 : tdhock 90 }
15 :     \details{Extraction of S4 class documentation is currently limited to expressions
16 :     within the source code which have first line starting with
17 :     \code{setClass("classname"}. These are located from the source file
18 :     (allowing also for white space around the \code{setClass} and ).
19 :     Note that \code{"classname"} must be a quoted character string;
20 :     expressions returning such a string are not matched.
21 :    
22 :     For class definitions, the slots (elements of the
23 :     \code{representation} list) fill the role of function
24 :     arguments, so may be documented by comments on
25 :     the same line or comments at the beginning of the
26 :     following line.
27 :    
28 :     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 109 \author{Inlinedocs development team <inlinedocs-support@lists.r-forge.r-project.org>}
35 : tdhock 90
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