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

1 : tdhock 90 \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.file)
11 :     }
12 :     \arguments{
13 :     \item{code.file}{
14 :     }
15 :     }
16 :     \details{If the definition chunk does not contain a
17 :     description, any immediately preceding sequence consecutive
18 :     "prefix" lines will be used instead.
19 :    
20 :     Class and method definitions can take several forms,
21 :     determined by expression type: \describe{
22 :     \item{assignment (<-)}{Ordinary assignment of value/function;}
23 :     \item{setClass}{Definition of S4 class;}
24 :     \item{setConstructorS3}{Definition of S3 class using R.oo package;}
25 :     \item{setMethodS3}{Definition of method for S3 class using R.oo package.}}
26 :     Additionally, the value may be a name of a function defined elsewhere,
27 :     in which case the documentation should be copied from that other definition.
28 :     This is handled using the concept of documentation links.
29 :    
30 :     The \code{setMethodS3} calls introduce additional
31 :     complexity: they will define an additional S3 generic (which
32 :     needs documentation to avoid warnings at package build time)
33 :     unless one already exists. This also is handled by "linking"
34 :     documentation. A previously unseen generic is linked to the
35 :     first defining instances, subsequent definitions of that generic
36 :     also link back to the first defining instance.}
37 :     \value{Returns an invisible list of .DocLink objects.}
38 :    
39 :     \author{Toby Dylan Hocking <toby.hocking@inria.fr>, Keith Ponting <k.ponting@aurix.com>}
40 :    
41 :    
42 :    
43 :    
44 :    

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