[Rcpp-devel] best way of documenting Rcpp Modules

[Hao Ye]

Hi Luis,

I recall having this problem, and I, too, had solved it by creating .Rd
files for the c++ class objects.

I don't have this error anymore, and I believe the main difference is that
I am curating my NAMESPACE file manually to only export the R functions
instead of everything ~ `exportPattern("^[[:alpha:]]+")`

You may want to give that a try.

If that doesn't work, it would help to see this issue as a minimal
reproducible example, e.g. a link to a GitHub repo.

Best,
--
Hao Ye
hye at ucsd.edu

On Tue, Aug 15, 2017 at 4:12 PM, Luis Avila <lmavila at gmail.com> wrote:

> I've used Roxygen to document my R classes
> but having problems now documenting Rcpp exposed classes from my C++ code.
>
> I am creating .Rd files manually and that partially solves the problem but
> looking for a better way.
>
> I have a module expossing c++ classes Model and NormalModel.
> Running R CMD check --as-cran I get:
>
> Undocumented code objects:
> 'Model'
>
> Undocumented S4 classes
> 'Rcpp_Model' 'Rcpp_NormalModel'
>
> I managed to get the "undocumented code object" message to stop reporting
> "NormalModel" as undocumented by manually setting up a NormalModel-class.Rd
> file in man but can't get rid of Rcpp_NormalModel.
>
> Is there a way to hide the classes with the Rcpp suffix, or what is the
> recommended way to fix this problem?
>
> Thank you.
>
> Luis
>
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.r-forge.r-project.org/pipermail/rcpp-devel/attachments/20170815/e9550d87/attachment.html>