roxygen2-package: roxygen2: In-Line Documentation for R

Description Details Author(s) See Also

Description

logo

Generate your Rd documentation, 'NAMESPACE' file, and collation field using specially formatted comments. Writing documentation in-line with code makes it easier to keep your documentation up-to-date as your requirements change. 'Roxygen2' is inspired by the 'Doxygen' system for C++.

Details

See vignette("roxygen2", package = "roxygen2") for an overview of the package, vignette("rd", package = "roxygen2") for generating documentation, and vignette("namespace", package = "roxygen2") for generating the namespace specification.

If you have existing Rd files, check out the Rd2roxygen package for a convenient way of converting Rd files to roxygen comments.

Author(s)

Maintainer: Hadley Wickham hadley@rstudio.com (ORCID) [copyright holder]

Authors:

Other contributors:

See Also

Useful links:


roxygen2 documentation built on Sept. 8, 2021, 9:08 a.m.