[Roxygen-devel] roxygen3

[Hadley Wickham]

I've also been wondering about splitting "roxygen3" into two packages
- one that defines all the basic objects etc and one that creates all
the tags.  That would would more cleanly separate the implementation
from the tag system, and make it easier for others to use roxygen to
build alternative documentation systems. One priority for roxygen3 is
that it should be much easier to extend, so that if I don't want to
include something, it's still easy for you to put it in an add-on
package.

Hadley

On Tue, Aug 28, 2012 at 11:46 AM, Hadley Wickham <hadley at rice.edu> wrote:
>> Is it object oriented this time?  From what I can follow from the HEAD,
>> it comes pretty close, but it is not S4 driven.
>
> Yes, it's more object-oriented, but with S3, not S4.
>
>> May be I am missing the point here, but it looks to me that doc/tag
>> parsers should be generics. A package might want to document and parse
>> the roxy-doc of it's objects in a class dependent way. So why not to use
>> the native S4 mechanism?
>
> See the doctype, object_from_call, usage and default_exports generics.
>  I don't see the need for every tag to be class aware just a few.
>
>> Also would be good to have a roc_template generic, which would generate
>> a bare-bone documentation of an object. This is for editors to be able
>> to quickly insert a roxygen template based on the object at the cursor
>> and its class.
>
> Can you give an example?  Generally, if you can automatically generate
> the template, why can't you automatically generate the Rd directly?
>
> Hadley
>
> --
> Assistant Professor
> Department of Statistics / Rice University
> http://had.co.nz/



-- 
Assistant Professor
Department of Statistics / Rice University
http://had.co.nz/