Learn R Programming
rdoxygen (version 1.0.0)

doxy_init: 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

Run this code

## Not run: ------------------------------------
# doxy_init()
## ---------------------------------------------

Run the code above in your browser using DataLab