[Rcpp-devel] rcmdcheck() failing on "Undocumented S4 class" with RCPP_Module

[John Clarke]

Thanks again Dirk,

So, I think my remaining issue is not to do with how we get the documents
(roxygen2 or manually) but rather that there appears to be two (2)
documents required by the R CMD check for the same class: *Rcpp_MyClass*
and *MyClass*. and Rcpp_MyClass doesn't appear to be relevant to the
end-user. But maybe I've got this wrong. I don't even really know how to
document Rcpp_MyClass because it is generated by Rcpp (correct?). I feel
I'm not getting something here -- should there be two classes that R CMD is
detecting? If so, what is the canonical way to document them? Maybe the
answer is simple: there will be duplicate documentation. But this doesn't
seem right to me.

Thanks,

-John

On Fri, Oct 4, 2024 at 6:52 PM Dirk Eddelbuettel <edd at debian.org> wrote:

>
> On 4 October 2024 at 17:21, John Clarke wrote:
> | Indeed roxygen2 docs will help with a workaround, I think. I've
> temporarily
> | added a Rcpp_MyClass-class.RD based on promptClass("Rcpp_MyClass") and
> that
> | seems to satisfy the R CMD check.
>
> Nice, and I think that is about as it good as you will get it.  Note that
> Rcpp basically never mentions roxygen2 (we support in C++ files where
> compileAttributes() carries it to the R file where it gets picked up), and
> neither does Writing R Extensions. The only official way is writing Rd
> files. Be it by hand, be it with roxygen2 help and workarounds.
>
> The only other idea I had was to use @name to give your existing entry the
> (missing) desired name and try @aliases to map back.  No idea if that would
> work.
>
> Cheers, Dirk
>
> --
> dirk.eddelbuettel.com | @eddelbuettel | edd at debian.org
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.r-forge.r-project.org/pipermail/rcpp-devel/attachments/20241008/46785b13/attachment.htm>