| Title: | Create Doxygen Documentation for Source Code |
| Version: | 1.0.0 |
| Maintainer: | Clemens Schmid <clemens@nevrome.de> |
| Description: | Create doxygen documentation for source code in R packages. Includes 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 |
R frontend of the C function bar
Description
A mask function to test if the dummy C code in src/bar.c works.
Usage
c_test(x)
Arguments
x |
a numeric vector |
Details
c_test(x) = x^2.
Value
a numeric vector x^2
Examples
## Not run:
x <- rnorm(10)
c_test(x)
## End(Not run)
check for doxygen
Description
helper function to check if doxygen is in the system path
Usage
check_for_doxygen()
Value
TRUE
Calls doxygen for an R package
Description
Triggers doxygen documentation for the code in src/. Triggers also
the setup (with doxy_init()) at the first run.
Usage
doxy(doxygen = file.exists("src"), roxygen = FALSE,
pathToDoxyfile = "./inst/doxygen/Doxyfile")
Arguments
doxygen |
A boolean: should doxygen be ran on documents in src/? Default: TRUE if a src folder exist and FALSE if not |
roxygen |
A boolean: should devtools::document() be ran after the creation of the doxygen documentation? Default: FALSE |
pathToDoxyfile |
A string with the relative path to the Doxyfile. Default: "./inst/doxygen/Doxyfile" |
Value
NULL or the value returned by devtools::document()
Examples
## Not run:
doxy()
## End(Not run)
Edits an existing Doxyfile
Description
Changes options in doxygen config files.
Usage
doxy_edit(pathToDoxyfile = "./inst/doxygen/Doxyfile", options = c())
Arguments
pathToDoxyfile |
A string with the relative path to the Doxyfile. Default: "./inst/doxygen/Doxyfile" |
options |
A named vector with new settings. The names represent the tags. A list of options can be found here: https://www.stack.nl/~dimitri/doxygen/manual/config.html |
Examples
## Not run:
doxy_edit(options = c("EXTRACT_PRIVATE" = "YES"))
## End(Not run)
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)
Updates and adds doxygen options in a line string vector
Description
Scans the lines and changes the value for the named tag if one line has this tag, adds a line at the end if no line has this tag and returns a warning if several lines match the tag.
Usage
replace_tag(fileStrings, tag, newVal)
Arguments
fileStrings |
A vector with each string containing a line of the file |
tag |
A string with the tag to be searched for |
newVal |
A string with the new value for the tag |
Value
The vector of strings with the new value