roxygen2 6.0.1

roxygen2 6.0.0


Improved inheritance

Minor improvements and bug fixes





Extending roxygen2

roxygen2 5.0.1

roxygen2 5.0.0

New features

Minor features and bug fixes

Internal changes

roxygen2 4.1.1

roxygen2 4.1.0

roxygen2 4.0.2

roxygen2 4.0.1

roxygen2 4.0.0

Roxygen2 4.0.0 is a major update to roxygen2 that makes provides enhanced error handling and considerably safer default behaviour. Now, roxygen2 will never overwrite a file that it did not create. This means that before you run it for the first time, you'll need to run roxygen2::upgradeRoxygen(). That will flag all existing files as being created by roxygen2.

New features

Improved error handling

Bug fixes and minor improvements

roxygen2 3.1.0

Documentation for reference classes

It's now possible to document reference classes, using the "docstring" convention described in ?setRefClass. If you want to provide a short paragraph description of what a method does, make the first component of the message a string containing the description, e.g.:

setRefClass("A", methods = list(
  f = function(a, b) {
    "Take numbers \code{a} and \code{b} and add them together"
    a + b

Unlike the documentation for R functions, the documentation for methods can be quite succinct.

Roxygen adopts the convention that documented methods are public, and will be listed in the man page for the object. Undocumented methods are private and will not be shown in the documentation. The methods for all superclasses are also listed, so that you don't need to flip through multiple pages of documentation to understand what you can do with an object. All documented methods will be placed in a bulleted list in a section titled "Methods", the method usage will be automatically prepended to the docstring.

Minor fixes and improvements

roxygen2 3.0.0

Roxygen2 now fully supports S4 and RC (reference classes) - you should no longer need to manually add @alias or @usage tags for S4 classes, methods and generics, or for RC classes.

S3 support has also been improved: roxygen2 now figures out whether a function is a S3 method or generic. (In the rare cases it does so incorrectly, use @method to manually describe the generic and class associated with a method). This means you can remove existing uses of @method, and can replace @S3method with @export.

Roxygen now has support for package specific options through the Roxygen field in the DESCRIPTION. The value of the field should be R code that results in a list. Currently only wrap and roclet values are supported:

Roxygen 3.0 also includes a number of minor fixes and improvements:

roxygen2 2.2.2

roxygen2 2.2.1

roxygen2 2.2

New features

Bug fixes


   useDynLib(packageName, routine1)
   useDynLib(packageName, routine2)

in the NAMESPACE file, instead of separate (wrong) useDynLib statements as before.

roxygen2 2.1

New features

Bug fixes

roxygen2 2.0

Major changes

Minor changes

New tags