doxy_vignette: Creates a doxygen vignette

In nevrome/rdoxygen: Create Doxygen Documentation for Source Code

Description

Creates an R Markdown wrapper for the doxygen documentation, so that it can be viewed from within R with a call to vignette().

Usage

doxy_vignette(pkg = ".", index = "html", viname, vientry)

Arguments

pkg	A string with the path to any subfolder of the R package root directory. Default: ".".
index	A string with the path relative to inst/doxygen of the doxygen index.html file. Default: html (see Note).
viname	A string giving the name of the .Rmd vignette file wrapping the documentation, as well as the name by which to retrieve the documentation using vignette(). Default: "pkgName-Doxygen.Rmd".
vientry	A character string specifying the vignette Index Entry to use. Default: "pkgName C++ library documentation".

Details

This function creates the file vignettes/viname.Rmd in the package root folder, containing the necessary meta-data for viewing the Doxygen HTML documentation from within R with a call to vignette().

Value

NULL

Note

The call to vignette() will *only* open HTML files stored in the doc subfolder of an installed package. Therefore, a natural location for the doxygen documentation (doxydoc) is in inst/doc/doxygen. However, the latest version of devtools incontrovertibly deletes inst/doc during the build/install process. Due to the ubiquitous usage of devtools among R package developers, the doxydoc is stored here in inst/doxygen, and during the build process, moved (or technically, copied and source added to .Rbuildignore) via a vignettes/Makefile. Packages with their own such Makefile will not have it overwritten, and developers may view the default Makefile provided by rdoxygen with the call

cat(readLines(system.file("sys", "Makefile",
                          package = "rdoxygen")), sep = "\n")

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