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 62, Tue Dec 8 15:00:47 2009 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(code.file)  
 }  
8  \arguments{  \arguments{
9    \item{code.file}{    \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
11    class definitions.}
12  }  }
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
# Line 24  Line 23 
23  the same line or \code{### } 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.}
 \value{  
 }  
 \references{  
 }  
 \author{Toby Dylan Hocking <toby.hocking@inria.fr>, Keith Ponting <k.ponting@aurix.com>}  
 \note{  
 }  
33    
34    
35  \seealso{  \author{Inlinedocs development team
36  }  <inlinedocs-support@lists.r-forge.r-project.org>}
37  \examples{}  
38    
39    
40    
41    

Legend:
Removed from v.62  
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