inspect_Rd(rdo, package = NULL)
inspect_Rdfun(rdo, alias_update = TRUE)
inspect_Rdmethods(rdo, package = NULL)
inspect_Rdclass(rdo)TRUE, add missing alias entries for
functions with usage statements.rdo
are consistent with their current definitions and update them, if
necessary. The details depend on the type of the documented topic.
In general, the functions update entries that can be produced
programmatically, possibly accompanied with a suggestion to the author
to write some additional text.
inspect_Rd checks the rdo and
dispatches to one of the other inspect_XXX functions depening
on the type of the topic.
inspect_Rdfun processes documentation of functions. It checks
the usage entries of all functions documented in rdo and
updates them if necessary. It appends "inspect_Rdfun understands
the syntax for S3 methods and S4 methods used in "usage" sections, as
well.
inspect_Rdmethods checks and updates documentation of an S4
generic function.
inspect_Rdclass checks and updates documentation of an S4
class.
Since method signatures and descriptions may be present in
documentation of a class, as well as in that of methods, the question
arises where to put "