[Roxygen-devel] Autodocumentation for S4 classes, methods and generics

Hadley Wickham h.wickham at gmail.com
Wed Sep 12 19:37:40 CEST 2012


> Reference classes basically are S4 classes, so it would be nice to the same
> basic features for both.

I think that should just work.  I have:

setClass("R5ClassObject", contains = "S4ClassObject")

so reference classes will inherit all S4 class behaviour by default.

> Reference classes of course have some additional
> notions, like class-based methods and fields that are potentially
> encapsulated via active bindings and thus suitable for public access. Not
> sure how one would rectify roxygen with the docstring feature.

As a first pass, the class documentation could just include a list of
all methods and their docstrings.

Hadley

-- 
RStudio / Rice University
http://had.co.nz/


More information about the Roxygen-devel mailing list