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.

Getting started

Package details

AuthorToby Dylan Hocking [aut, cre], Keith Ponting [aut], Thomas Wutzler [aut], Philippe Grosjean [aut], Markus Müller [aut], R Core Team [ctb, cph]
MaintainerToby Dylan Hocking <toby.hocking@r-project.org>
LicenseGPL-2 | GPL-3
Version2023.9.4
URL https://github.com/tdhock/inlinedocs
Package repositoryView on CRAN
Installation Install the latest version of this package by entering the following in R:
install.packages("inlinedocs")

Try the inlinedocs package in your browser

Any scripts or data that you put into this service are public.

inlinedocs documentation built on Oct. 19, 2023, 1:06 a.m.