doxy_init {rdoxygen}

Prepares the R package structure for use with doxygen

Description

Creates a configuration file in inst/doxygen/ and sets a few options:

• EXTRACT_ALL = YES

• INPUT = src/

• OUTPUT_DIRECTORY = inst/doxygen/

Usage

doxy_init(rootFolder = ".")

Arguments

rootFolder

A string with the path to the root directory of the R package. Default: "."

Examples

## Not run: 
doxy_init()

## End(Not run)