The R Project SVN R

Rev

Rev 85981 | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 85981 Rev 87262
Line 1... Line 1...
1 
% File src/library/tools/man/QC.Rd
 1 
% File src/library/tools/man/QC.Rd
2 
% Part of the R package, https://www.R-project.org
 2 
% Part of the R package, https://www.R-project.org
3 
% Copyright 1995-2023 R Core Team
 3 
% Copyright 1995-2024 R Core Team
4 
% Distributed under GPL 2 or later
 4 
% Distributed under GPL 2 or later
5 
 
 5 
 
6 
\name{QC}
 6 
\name{QC}
7 
\title{QC Checks for R Code and/or Documentation}
 7 
\title{QC Checks for R Code and/or Documentation}
8 
\alias{QC}
 8 
\alias{QC}
Line 47... Line 47...
47 
    (default), these are checked \dQuote{specially}, ignoring missing
 47 
    (default), these are checked \dQuote{specially}, ignoring missing
48 
    documentation of arguments.}
 48 
    documentation of arguments.}
49 
}
 49 
}
50 
\details{
 50 
\details{
51 
  \code{checkDocFiles} checks, for all Rd files in a package, whether all
 51 
  \code{checkDocFiles} checks, for all Rd files in a package, whether all
52 
  arguments shown in the usage sections of the Rd file are documented in
 52 
  functions shown in the usage section of the Rd file have a corresponding
- 
 
 53 
  \verb{\alias},%(except if any ends with \samp{-deprecated})
- 
 
 54 
  and all of their arguments are documented in
53 
  its arguments section.  It also reports duplicated entries in the
 55 
  the arguments section.  It also reports duplicated entries in the
54 
  arguments section, and \sQuote{over-documented} arguments which are
 56 
  arguments section, and \sQuote{over-documented} arguments which are
55 
  given in the arguments section but not in the usage.
 57 
  given in the arguments section but not in the usage.
56 
 
 58 
 
57 
  \code{checkDocStyle} investigates how (S3) methods are shown in the
 59 
  \code{checkDocStyle} investigates how (S3) methods are shown in the
58 
  usages of the Rd files in a package.  It reports the methods shown by
 60 
  usages of the Rd files in a package.  It reports the methods shown by