[Roxygen-devel] exclude functions from roxygen

[Jeroen Ooms]

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