roxygenize {roxygen} | R Documentation |
This is the workhorse function that uses roclets, the built-in document
transformation functions, to build all documentation for a package.
See the documentation for the individual roclets, rd_roclet()
,
namespace_roclet()
, and for update_collate()
, for more details.
roxygenize(package.dir);
Note that roxygen2 is a dynamic documentation system: it works by inspecting loaded objects in the package. This means that you must be able to load the package in order to document it: see load for details.
a tuple list of the R function documentation symbols data