# SCM Repository

[inlinedocs] View of /pkg/inlinedocs/man/extract.file.parse.Rd
 [inlinedocs] / pkg / inlinedocs / man / extract.file.parse.Rd

# View of /pkg/inlinedocs/man/extract.file.parse.Rd

Mon May 3 14:03:10 2010 UTC (9 years, 3 months ago) by tdhock
File size: 1764 byte(s)
unix line endings
\name{extract.file.parse}
\alias{extract.file.parse}
\title{File content analysis}
the default description for that chunk. The analysis also looks for
S4 class "setClass" calls and R.oo setConstructorS3 and setMethodS3
calls in order to link the documentation of those properly.}
\usage{
extract.file.parse(code.file)
}
\arguments{
\item{code.file}{
}
}
\details{If the definition chunk does not contain a
description, any immediately preceding sequence consecutive
"prefix" lines will be used instead.

Class and method definitions can take several forms,
determined by expression type: \describe{
\item{assignment (<-)}{Ordinary assignment of value/function;}
\item{setClass}{Definition of S4 class;}
\item{setConstructorS3}{Definition of S3 class using R.oo package;}
\item{setMethodS3}{Definition of method for S3 class using R.oo package.}}
Additionally, the value may be a name of a function defined elsewhere,
in which case the documentation should be copied from that other definition.
This is handled using the concept of documentation links.

complexity: they will define an additional S3 generic (which
needs documentation to avoid warnings at package build time)
documentation. A previously unseen generic is linked to the
first defining instances, subsequent definitions of that generic
also link back to the first defining instance.}
\value{Returns an invisible list of .DocLink objects.}

\author{Toby Dylan Hocking <toby.hocking@inria.fr>, Keith Ponting <k.ponting@aurix.com>}