MyNixOS website logo
Description

Create Doxygen Documentation for Source Code.

Create doxygen documentation for source code in R packages. Includes a RStudio Addin, that allows to trigger the doxygenize process.

rdoxygen

R package for the automatic creation of doxygen documentation for source code in R packages.

It's based on cmbarbus answer to this stackoverflow question.

Installation

:exclamation: To use rdoxygen you need a working installation of the system program doxygen.

You can install the development version of rdoxygen with devtools via

if(!require('devtools')) install.packages('devtools')
library(devtools)
install_github('nevrome/rdoxygen')

Usage

To setup and afterwards update your doxygen documentation, you can simply run

doxy()

in your package root directory. doxy() calls doxy_init() if there's no Doxyfile (doxygen configuration file) yet. Otherwise it just updates the documentation.

The package provides a RStudio Addin named rdoxygenize that binds to the function doxy(). doxy() can therefore be called with a keyboard shortcut (I personally use CTR/kbd+SHIFT+-). This makes the user experience comparable to roxygen2 documentation via devtools::document() (usually CTR/kbd+SHIFT+D).

doxy_edit() allows to change settings in the Doxyfile. For example to also include private elements, you can call

doxy_edit(options = c("EXTRACT_PRIVATE" = "YES"))

Licence

rdoxygen is released under the GNU General Public Licence, version 2. Comments and feedback are welcome, as are code contributions.

Metadata

Version

1.0.0

License

Unknown

Platforms (75)

    Darwin
    FreeBSD
    Genode
    GHCJS
    Linux
    MMIXware
    NetBSD
    none
    OpenBSD
    Redox
    Solaris
    WASI
    Windows
Show all
  • aarch64-darwin
  • aarch64-genode
  • aarch64-linux
  • aarch64-netbsd
  • aarch64-none
  • aarch64_be-none
  • arm-none
  • armv5tel-linux
  • armv6l-linux
  • armv6l-netbsd
  • armv6l-none
  • armv7a-darwin
  • armv7a-linux
  • armv7a-netbsd
  • armv7l-linux
  • armv7l-netbsd
  • avr-none
  • i686-cygwin
  • i686-darwin
  • i686-freebsd
  • i686-genode
  • i686-linux
  • i686-netbsd
  • i686-none
  • i686-openbsd
  • i686-windows
  • javascript-ghcjs
  • loongarch64-linux
  • m68k-linux
  • m68k-netbsd
  • m68k-none
  • microblaze-linux
  • microblaze-none
  • microblazeel-linux
  • microblazeel-none
  • mips-linux
  • mips-none
  • mips64-linux
  • mips64-none
  • mips64el-linux
  • mipsel-linux
  • mipsel-netbsd
  • mmix-mmixware
  • msp430-none
  • or1k-none
  • powerpc-netbsd
  • powerpc-none
  • powerpc64-linux
  • powerpc64le-linux
  • powerpcle-none
  • riscv32-linux
  • riscv32-netbsd
  • riscv32-none
  • riscv64-linux
  • riscv64-netbsd
  • riscv64-none
  • rx-none
  • s390-linux
  • s390-none
  • s390x-linux
  • s390x-none
  • vc4-none
  • wasm32-wasi
  • wasm64-wasi
  • x86_64-cygwin
  • x86_64-darwin
  • x86_64-freebsd
  • x86_64-genode
  • x86_64-linux
  • x86_64-netbsd
  • x86_64-none
  • x86_64-openbsd
  • x86_64-redox
  • x86_64-solaris
  • x86_64-windows