rdoxygen (version 1.0.0)

doxy: Calls doxygen for an R package

Description

Triggers doxygen documentation for the code in src/. Triggers also the setup (with doxy_init()) at the first run.

Usage

doxy(doxygen = file.exists("src"), roxygen = FALSE,
  pathToDoxyfile = "./inst/doxygen/Doxyfile")

Arguments

doxygen

A boolean: should doxygen be ran on documents in src/? Default: TRUE if a src folder exist and FALSE if not

roxygen

A boolean: should devtools::document() be ran after the creation of the doxygen documentation? Default: FALSE

pathToDoxyfile

A string with the relative path to the Doxyfile. Default: "./inst/doxygen/Doxyfile"

Value

NULL or the value returned by devtools::document()

Examples

## Not run: ------------------------------------
#   doxy()
## ---------------------------------------------