[Roxygen-devel] support for \section tag in Rd2roxygen ?

[Brian G. Peterson]

Thanks for the reply,  but I think you misunderstood the question.

Rd2roxygen seems to completely fail to parse \section tags in the
existing Rd files.  There's no error, but no section data is converted
either.

Regards,

  - Brian



On Wed, 2011-09-21 at 14:39 -0500, Hadley Wickham wrote:
> What format are you using for the section tag?  In plyr, I have:
> 
> #' @section Output:
> #'   The most unambiguous behaviour is achieved when \code{.fun} returns a
> #'   data frame - in that case pieces will be combined with
> #'   \code{\link{rbind.fill}}.  If \code{.fun} returns an atomic vector of
> #'   fixed length, it will be \code{rbind}ed together and converted to a data
> #'   frame. Any other values will result in an error.
> 
> and that works fine.  Did you miss the colon?
> 
> Hadley
> 
> On Sun, Sep 18, 2011 at 6:24 AM, Brian G. Peterson <brian at braverock.com> wrote:
> > I'm in the process of trying to convert the over 140 pages of
> > documentation for the PerformanceAnalytics package from hand-coded .Rd
> > files to roxygen2
> >
> > I've previously gotten some assistance here with regard to aliases and
> > multiple functions in the same file, and with some small changes to the
> > source documents have made significant progress.  (i.e. Rd2roxygen can
> > now run to completion)
> >
> > I'm now noticing that the documentation produced by Rd2roxygen is
> > significantly shorter than the original.
> >
> > So far, Ive been able to identify that it appears that Rd2roxygen fails
> > to parse \section tags completely.  There are no errors or warnings, but
> > all of the text contained in \section tags in the original Rd files is
> > completely missing from the converted roxygen comments.
> >
> > Am I missing something, or am I correct that it is Rd2roxygen?
> >
> > Regards,
> >
> >   - Brian
> >