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

[Michael Lawrence]

On Wed, Sep 12, 2012 at 10:21 AM, Hadley Wickham <h.wickham at gmail.com>wrote:

> >> * a picture showing the class graph to the class documentation
> >> * a list of "nearby" methods to method documentation
> >
> > I miss the old CallGraph functionality from the original roxygen, so I'd
> > like to hope that any graphing capability would include this , and
> support
>
> Do you have any particularly good examples where this is useful?
>
> > S3 and Reference Classes as well as S4.
>
> S3 is already supported - although there's no formal notion of an S3
> class so there's only so much we can do.
>
> I'm not sure what supporting reference classes would entail (esp. with
> the alternative doc system built into ref classes).  Do you have any
> hand written Rd files you could share?
>
>
Reference classes basically are S4 classes, so it would be nice to the same
basic features for both.  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.

Hadley
>
> --
> RStudio / Rice University
> http://had.co.nz/
> _______________________________________________
> Roxygen-devel mailing list
> Roxygen-devel at lists.r-forge.r-project.org
> https://lists.r-forge.r-project.org/cgi-bin/mailman/listinfo/roxygen-devel
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.r-forge.r-project.org/pipermail/roxygen-devel/attachments/20120912/f79f1cc6/attachment.html>