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

1 : tdhock 62 \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(code.file)
9 :     }
10 :     \arguments{
11 :     \item{code.file}{
12 :     }
13 :     }
14 :     \details{Extraction of S4 class documentation is currently limited to expressions
15 :     within the source code which have first line starting with
16 :     \code{setClass("classname"}. These are located from the source file
17 :     (allowing also for white space around the \code{setClass} and \code{(}).
18 :     Note that \code{"classname"} must be a quoted character string;
19 :     expressions returning such a string are not matched.
20 :    
21 :     For class definitions, the slots (elements of the
22 :     \code{representation} list) fill the role of function
23 :     arguments, so may be documented by \code{##<<} comments on
24 :     the same line or \code{### } comments at the beginning of the
25 :     following line.
26 :    
27 :     The class definition skeleton includes an \code{Objects from the Class}
28 :     section, to which any \code{##details<<} documentation chunks are
29 :     written. It is given a vanilla content if there are no specific
30 :     \code{##details<<} documentation chunks.}
31 :     \value{
32 :     }
33 :     \references{
34 :     }
35 :     \author{Toby Dylan Hocking <toby.hocking@inria.fr>, Keith Ponting <k.ponting@aurix.com>}
36 :     \note{
37 :     }
38 :    
39 :    
40 :     \seealso{
41 :     }
42 :     \examples{}

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