Description Usage Arguments Details Value Examples
Creates a Doxygen configuration file and sets a few options:
INPUT = src/ inst/include
OUTPUT_DIRECTORY = inst/doxygen/
GENERATE_LATEX = NO
HIDE_UNDOC_MEMBERS = YES
USE_MATHJAX = YES
PROJECT_NAME = name_of_R_package
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 |
verbose |
Logical. If |
While the package developer is free to change the OUTPUT_DIRECTORY
to wherever they like, the default value above is suggested for compatibility with the
devtools package authoring workflow. See doxy_vignette
for details.
NULL
.
1 2 3 4 | ## Not run:
doxy_init()
## End(Not run)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.