make.Rd2.roclet: New implementation of the Rd roclet; same functionality as...

Description Usage Arguments Details Value

Description

New implementation of the Rd roclet; same functionality as the original implementation plus basic S4 handling.

Usage

1
2
make.Rd2.roclet(subdir, verbose=TRUE, exportonly=FALSE,
    documentedonly=TRUE)

Arguments

subdir

directory into which to place the Rd files; if NULL, standard out.

verbose

whether to declare what we're doing in the subdir

exportonly

create Rd files only for exported "things"

documentedonly

create Rd files only for "things" which are documented with Roxygen

Details

See make.Rd.roclet for description and available tags; new tags are:

  1. @nordSuppress Rd creation.

  2. @rdnameDefinition of the Rd name; blocks with the same @rdname are merged into one Rd file.

  3. @slotEach S4 class slot should have a @slot <name> <description> specified.

Value

Rd roclet


roxygen documentation built on May 2, 2019, 4:44 p.m.