Description Usage Arguments Value Examples
View source: R/doxygen_tools.R
Triggers doxygen documentation for the code in src/. Triggers also
the setup (with doxy_init()
) at the first run.
1 2 | doxy(doxygen = file.exists("src"), roxygen = FALSE,
pathToDoxyfile = "./inst/doxygen/Doxyfile")
|
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" |
NULL or the value returned by devtools::document()
1 2 3 4 | ## Not run:
doxy()
## End(Not run)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.