doxy_init: Prepares the R package structure for use with doxygen

In nevrome/rdoxygen: Create Doxygen Documentation for Source Code

Description

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

Usage

doxy_init(pkg = ".", doxyfile = "inst/doxygen/Doxyfile",
  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".
verbose	Logical. If FALSE, suppresses Doxygen output. Default: TRUE.

Details

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.

Value

NULL.

Examples

## Not run: 
doxy_init()

## End(Not run)

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