inlinedocs: Convert Inline Comments to Documentation

Generates Rd files from R source code with comments. The main features of the default syntax are that (1) docs are defined in comments near the relevant code, (2) function argument names are not repeated in comments, and (3) examples are defined in R code, not comments. It is also easy to define a new syntax.

Version: 2023.9.4
Depends: methods, utils, R (≥ 2.9)
Suggests: future.apply, future, R.methodsS3
Published: 2023-10-18
DOI: 10.32614/CRAN.package.inlinedocs
Author: Toby Dylan Hocking [aut, cre], Keith Ponting [aut], Thomas Wutzler [aut], Philippe Grosjean [aut], Markus Müller [aut], R Core Team [ctb, cph]
Maintainer: Toby Dylan Hocking <toby.hocking at r-project.org>
BugReports: https://github.com/tdhock/inlinedocs/issues
License: GPL-2 | GPL-3
URL: https://github.com/tdhock/inlinedocs
NeedsCompilation: no
Citation: inlinedocs citation info
Materials: NEWS
CRAN checks: inlinedocs results

Documentation:

Reference manual: inlinedocs.pdf

Downloads:

Package source: inlinedocs_2023.9.4.tar.gz
Windows binaries: r-devel: inlinedocs_2023.9.4.zip, r-release: inlinedocs_2023.9.4.zip, r-oldrel: inlinedocs_2023.9.4.zip
macOS binaries: r-release (arm64): inlinedocs_2023.9.4.tgz, r-oldrel (arm64): inlinedocs_2023.9.4.tgz, r-release (x86_64): inlinedocs_2023.9.4.tgz, r-oldrel (x86_64): inlinedocs_2023.9.4.tgz
Old sources: inlinedocs archive

Reverse dependencies:

Reverse suggests: directlabels

Linking:

Please use the canonical form https://CRAN.R-project.org/package=inlinedocs to link to this page.