doxy: Calls doxygen for an R package

In nevrome/rdoxygen: Create Doxygen Documentation for Source Code

Description

Creates doxygen documentation and optionally wraps it as an R vignette.

Usage

doxy(pkg = ".", doxyfile = "inst/doxygen/Doxyfile", options = c(),
  vignette = FALSE, verbose = TRUE)

Arguments

pkg	A string with the path to any subfolder of the R package root directory. Default: ".".
doxyfile	A string with the path to the Doxyfile relative to the package root folder indicated by pkg. Default: "inst/doxygen/Doxyfile".
options	A named vector with new settings. The names represent the tags. A list of options can be found here: http://www.doxygen.nl/manual/config.html.
vignette	A boolean. Should a vignette be added with doxy_vignette? Default: FALSE.
verbose	Logical. If FALSE, suppresses Doxygen output. Default: TRUE.

Details

This function will first create a Doxyfile with doxy_init if it doesn't yet exist. Next, it runs Doxygen on the Doxyfile, and if vignette = TRUE, creates a vignette allowing the Doxygen documentation to be viewed from within R with a call to vignette(). The Doxygen vignette is created with default options. To modify these options, see doxy_vignette.

Value

NULL

nevrome/rdoxygen documentation built on Sept. 5, 2019, 3:12 p.m.