[Roxygen-devel] S4 documentation

[Hadley Wickham]

>> There may be a use-case for @including Roxygen comments, but I think my
>> use-case would benefit more from pure Rd that would just be concatenated
>> into the resulting Rd file. These would be things like extra \section{}s.
>> Maybe make that more explicit with a @section that refers to a file?
>
> Maybe if the include file has an *.rdox suffix (or whatever), it could
> be normal roxygen formatted, and if it is *.Rd, it's just straight Rd
> text that's inlined into the appropriate place of the final
> roxygen-constructed Rd file.

And if it was .R it could be treated as commented roxygen tags.  I
think that would work well for @templates. There's no way that Rd
includes/templates can work in the short-term, because they need to be
parsed and converted in to roxygen's Rd object format, but long-term I
think it's reasonable.

Where do you think the files should live?  Templates currently live in
man-roxygen (i.e. that's where the path defaults to), but maybe they
should default to the root directory so you can specify where they
live.

Hadley

-- 
Assistant Professor / Dobelman Family Junior Chair
Department of Statistics / Rice University
http://had.co.nz/