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.


Reference manual

It appears you don't have a PDF plugin for this browser. You can click here to download the reference manual.

install.packages("inlinedocs")

2023.9.4 by Toby Dylan Hocking, 3 years ago


https://github.com/tdhock/inlinedocs


Report a bug at https://github.com/tdhock/inlinedocs/issues


Browse source code at https://github.com/cran/inlinedocs


Authors: Toby Dylan Hocking [aut, cre] , Keith Ponting [aut] , Thomas Wutzler [aut] , Philippe Grosjean [aut] , Markus Müller [aut] , R Core Team [ctb, cph]


Documentation:   PDF Manual  


GPL-2 | GPL-3 license


Depends on methods, utils

Suggests future.apply, future, R.methodsS3


Suggested by directlabels.


See at CRAN