SCM

SCM Repository

[inlinedocs] Annotation of /pkg/inlinedocs/man/extract.file.parse.Rd
ViewVC logotype

Annotation of /pkg/inlinedocs/man/extract.file.parse.Rd

Parent Directory Parent Directory | Revision Log Revision Log


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

1 : tdhock 125 \name{extract.file.parse}
2 :     \alias{extract.file.parse}
3 :     \title{File content analysis}
4 :     \description{Using the base \code{\link{parse}} function, analyse the file to link
5 :     preceding "prefix" comments to each active chunk. Those comments form
6 :     the default description for that chunk. The analysis also looks for
7 :     S4 class "setClass" calls and R.oo setConstructorS3 and setMethodS3
8 :     calls in order to link the documentation of those properly.}
9 :     \usage{
10 :     extract.file.parse(code)
11 :     }
12 :     \arguments{
13 :     \item{code}{Lines of R source code in a character vector - note that any
14 :     nested \code{source} statements are \emph{ignored} when scanning
15 :     for class definitions.}
16 :     }
17 :     \details{If the definition chunk does not contain a
18 :     description, any immediately preceding sequence consecutive
19 :     "prefix" lines will be used instead.
20 :    
21 :     Class and method definitions can take several forms,
22 :     determined by expression type: \describe{
23 :     \item{assignment (<-)}{Ordinary assignment of value/function;}
24 :     \item{setClass}{Definition of S4 class;}
25 :     \item{setConstructorS3}{Definition of S3 class using R.oo package;}
26 :     \item{setMethodS3}{Definition of method for S3 class using R.oo package.}}
27 :     Additionally, the value may be a name of a function defined elsewhere,
28 :     in which case the documentation should be copied from that other definition.
29 :     This is handled using the concept of documentation links.
30 :    
31 :     The \code{setMethodS3} calls introduce additional
32 :     complexity: they will define an additional S3 generic (which
33 :     needs documentation to avoid warnings at package build time)
34 :     unless one already exists. This also is handled by "linking"
35 :     documentation. A previously unseen generic is linked to the
36 :     first defining instances, subsequent definitions of that generic
37 :     also link back to the first defining instance.}
38 :     \value{Returns an invisible list of .DocLink objects.}
39 :    
40 :     \author{Inlinedocs development team <inlinedocs-support@lists.r-forge.r-project.org>}
41 :    
42 :    
43 :    
44 :    
45 :    

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