{"Package":"rdoxygen","Title":"Create Doxygen Documentation for Source Code","Version":"1.0.0","Authors@R":"c(\nperson(\"Clemens\", \"Schmid\", email = \"clemens@nevrome.de\", role = c(\"cre\", \"cph\", \"aut\"))\n)","Maintainer":"Clemens Schmid ","Description":"Create doxygen documentation for source code in R packages.\nIncludes a RStudio Addin, that allows to trigger the doxygenize process.","Date":"2017-05-23","Depends":"R (>= 3.3.3)","License":"GPL-2 | file LICENSE","Encoding":"UTF-8","LazyData":"true","URL":"https://github.com/nevrome/rdoxygen","BugReports":"https://github.com/nevrome/rdoxygen/issues","RoxygenNote":"6.0.1","Imports":"devtools (>= 1.12.0)","Suggests":"testthat","SystemRequirements":"doxygen","NeedsCompilation":"yes","Packaged":"2017-05-25 21:11:20 UTC; clemens","Author":"Clemens Schmid [cre, cph, aut]","Repository":"CRAN","Date/Publication":"2017-05-25 21:39:04 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/rdoxygen_1.0.0.tar.gz","jsonAuthors":[{"name":"Clemens Schmid","email":"clemens@nevrome.de","maintainer":true}],"readme":"rdoxygen\n--------\n\nR package for the automatic creation of [doxygen](http://www.doxygen.org) documentation for source code in R packages. \n\nIt's based on [cmbarbus](http://stackoverflow.com/users/1174052/cmbarbu) answer to this [stackoverflow question](http://stackoverflow.com/questions/20713521/using-roxygen2-and-doxygen-on-the-same-package). \n\n\nInstallation\n------------\n\n:exclamation: To use rdoxygen you need a working installation of the system program [doxygen](http://www.stack.nl/~dimitri/doxygen/download.html). \n\nYou can install the development version of rdoxygen with [devtools](https://CRAN.R-project.org/package=devtools) via\n\n if(!require('devtools')) install.packages('devtools')\n library(devtools)\n install_github('nevrome/rdoxygen')\n\nUsage\n-----\n\nTo setup and afterwards update your doxygen documentation, you can simply run \n\n```{r}\ndoxy()\n```\n\nin your package root directory. `doxy()` calls `doxy_init()` if there's no Doxyfile (doxygen configuration file) yet. Otherwise it just updates the documentation. \n\nThe package provides a [RStudio Addin](https://rstudio.github.io/rstudioaddins/) named **rdoxygenize** that binds to the function `doxy()`. `doxy()` can therefore be called with a keyboard shortcut (I personally use CTRL+SHIFT+-). This makes the user experience comparable to [roxygen2](https://github.com/yihui/roxygen2) documentation via `devtools::document()` (usually CTRL+SHIFT+D). \n\n`doxy_edit()` allows to change settings in the Doxyfile. For example to also include private elements, you can call\n\n```{r}\ndoxy_edit(options = c(\"EXTRACT_PRIVATE\" = \"YES\"))\n```\n\nLicence\n-------\n\nrdoxygen is released under the [GNU General Public Licence, version 2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html). Comments and feedback are welcome, as are code contributions."}

Description

Usage

Arguments

Value

Details

Examples