roxygen2 (version 2.0)

rd_roclet: Roclet: make Rd files.

Description

This roclet is the workhorse of roxygen, producing the Rd files that document that functions in your package.

Details

This roclet also automatically runs checkRd on all generated Rd files so that you know as early as possible if there's a problem.

See Also

Other roclets: collate_roclet, namespace_roclet

Examples

roclet <- rd_roclet()
roc_proc(roclet, "example.R")
roc_out(roclet, "example.R", ".")