[Rcpp-devel] Roxygen2 + rcpp

JJ Allaire jj.allaire at gmail.com
Thu Feb 21 11:43:29 CET 2013


Hi Aileen,

If you are building a package with Rcpp and using the Rcpp::export
attribute to create R callable functions then you can indeed add Roxygen
comments to your C++ functions and they'll be picked up. Section 3.4 of the
Rcpp Attributes vignette covers this:

http://cran.r-project.org/web/packages/Rcpp/vignettes/Rcpp-attributes.pdf

J.J.

On Thu, Feb 21, 2013 at 1:17 AM, Aileen Lin <aileenshanhong.lin at gmail.com>wrote:

> Hi there,
>
> I gained a lot of benefit from your discussion and rcpp gallery. Thank you
> very much. Just wondering whether roxygen2 can read those comments in my
> .CPP files.
>
> Regards,
> Aileen Lin
>
> _______________________________________________
> Rcpp-devel mailing list
> Rcpp-devel at lists.r-forge.r-project.org
> https://lists.r-forge.r-project.org/cgi-bin/mailman/listinfo/rcpp-devel
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.r-forge.r-project.org/pipermail/rcpp-devel/attachments/20130221/d7d4bc26/attachment.html>


More information about the Rcpp-devel mailing list