[Roxygen-devel] S4 documentation

[Manuel J. A. Eugster]

>      > One last thing: documentation for classes can get pretty long. Is
>     there a
>      > way to @include extra files? Steve Lianoglou had this idea.
>
>     That's another interesting idea.  We currently have @template, which
>     is a superset of @include, but it might be worthwhile differentiating
>     them semantically.  Where would you imagine such include files living?
>       Would they be R files or plain text to be interpreted as roxygen
>     comments?  (We decided on R files for templates so that existing
>     syntax highlighting code would work)
>
>
> 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?

In roxygen (v1) existing Rd files in the Rd directory are merged with
the documentation generated by roxygen based on the file name and
@rdname.

Maybe we can implement something similar in roxygen2? Would that help?


Manuel.