The R Project SVN R

Rev

Rev 26963 | Rev 30805 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 26963 Rev 27623
Line 58... Line 58...
58 
  formals are compared between code and documentation according to the
 58 
  formals are compared between code and documentation according to the
59 
  values of the argument \code{use.values}.  Synopsis sections are used
 59 
  values of the argument \code{use.values}.  Synopsis sections are used
60 
  if present; their occurrence is reported if \code{verbose} is true.
 60 
  if present; their occurrence is reported if \code{verbose} is true.
61 
 
 61 
 
62 
  Currently, the R documentation format has no high-level markup for the
 62 
  Currently, the R documentation format has no high-level markup for the
63 
  basic \dQuote{structure} of classes and data sets (similar to the
 63 
  basic \dQuote{structure} of classes and data sets (similar to the usage
64 
  usage sections for function synopses).  Variable names for data frames
 64 
  sections for function synopses).  Variable names for data frames in
65 
  in documentation objects obtained by suitably editing \dQuote{shells}
 65 
  documentation objects obtained by suitably editing \dQuote{shells}
66 
  created by \code{\link{prompt}} are recognized by \code{codocData} and
 66 
  created by \code{\link[code]{prompt}} are recognized by \code{codocData}
67 
  used provided that the documentation object is for a single data frame
 67 
  and used provided that the documentation object is for a single data
68 
  (i.e., only has one alias).  \code{codocClasses} analogously handles
 68 
  frame (i.e., only has one alias).  \code{codocClasses} analogously
69 
  slot names for classes in documentation objects obtained by editing
 69 
  handles slot names for classes in documentation objects obtained by
70 
  shells created by \code{\link[methods]{promptClass}}.
 70 
  editing shells created by \code{\link[methods]{promptClass}}.
71 
}
 71 
}
72 
\value{
 72 
\value{
73 
  \code{codoc} returns an object of class \code{"codoc"}.  Currently,
 73 
  \code{codoc} returns an object of class \code{"codoc"}.  Currently,
74 
  this is a list which, for each Rd object in the package where an
 74 
  this is a list which, for each Rd object in the package where an
75 
  inconsistency was found, contains an element with a list of the
 75 
  inconsistency was found, contains an element with a list of the