提供通过Rcpp公开的C ++类的文档

时间:2015-04-12 08:31:53

标签: rcpp

假设我有一个小的C ++类,我已经内联了所有函数(并试图通过Roxygen per [Section 3.4]进行文档化):

class HelloWorld {
private:
    int count;
public:
//' the constructor for the class
HelloWorld() : count(0) {}

//' my magical function
//' @param arg the integer to add
//' @return the magical result
int example(int arg) { return 2*count+arg; }
};

我可以将这个类暴露给Rcpp:

RCPP_MODULE(helloworld){
    Rcpp::class_<HelloWorld>("HelloWorld")
        .constructor()
        .method("example", &HelloWorld::example, "A magical function.");
};

然而,Rcpp.package.skeleton()生成的R / RcppExports.R看起来像

#' the constructor for the class
NULL

#' Inserts an entry into the dictionary
#' @param arg the integer to add
#' @return the magical result
NULL

我确信我只是遗漏了一些明显的东西。有什么想法吗?

0 个答案:

没有答案