使用roxygen2记录Rcpp模块公开的方法

时间:2016-12-21 01:32:27

标签: r rcpp

我的包中有一个Rcpp模块,它暴露了类,暴露了许多方法。是否可以使用roxygen2记录方法(在C ++方面)?我的模块看起来像这样:

html {
    color: black;
}

.myClass {
    width: 100px;
}

}

我想理想地记录所有这些方法。一个简单的想法是隐藏包装函数后面的类,然后从R包装器函数中调用方法,但这对我来说感觉不太优雅。

我已经尝试将roxygen注释行添加到函数中,但是因为它们没有以相同的方式导出,所以文档似乎没有被提取。

1 个答案:

答案 0 :(得分:6)

由于您没有调用compileAttributes(),您将无法依赖Rcpp来携带compileAttributes()所需的roxygen文档。

随意构建(并测试然后贡献:)一个新的辅助函数;否则我只会在R文件中使用roxygen并从那里开始。

编辑:我也filed an issue这样我们就不会忘记它。