Description Usage Arguments Details Value
View source: R/doxygen_tools.R
Creates doxygen documentation and optionally wraps it as an R vignette.
1 2 |
pkg |
A string with the path to any subfolder of the R package root
directory. Default: |
doxyfile |
A string with the path to the |
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 |
verbose |
Logical. If |
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
.
NULL
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.