[Roxygen-devel] exclude functions from roxygen

[Charlie Sharpsteen]

I don't think so. I use a makefile that executes `roxygen` directly through
R and passes all the options I need:

  https://github.com/Sharpie/RTikZDevice/blob/master/Makefile#L69

-Charlie

On Sat, Jul 23, 2011 at 3:16 PM, Jeroen Ooms <jeroen.ooms at stat.ucla.edu>wrote:

> Can I do this through R CMD roxygen as well?
>
>
>
> On Sun, Jul 24, 2011 at 12:12 AM, Charlie Sharpsteen
> <chuck at sharpsteen.net> wrote:
> > On Sat, Jul 23, 2011 at 2:42 PM, Jeroen Ooms <jeroen.ooms at stat.ucla.edu>
> > wrote:
> >>
> >> Is there a directive that I can use to exclude functions from being
> >> parsed by roxygen? I have a package which defines a lot of functions,
> >> but only 2 are exported. I would only like to generate documentation
> >> for these two functions.
> >>
> >> However it seems roxygen automatically generated Rd files for all
> >> functions in the R folder. This is especially problematic because it
> >> chokes on some methods that I define for a class that is defined in
> >> another package. I would rather have that it only parses functions
> >> with an @export directive.
> >>
> >> Thanks.
> >
> > Try passing the argument `use.Rd2=TRUE` when calling `roxygenize`. Then
> > Roxygen will skip any function that is not preceded by documentation
> > comments ` #'  `.
> > -Charlie
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.r-forge.r-project.org/pipermail/roxygen-devel/attachments/20110723/f291c0d9/attachment.htm>