私のパッケージには、クラスを公開するだけでなく、多くのメソッドを公開するRcppモジュールがあります。 roxygen2を使って(C++側で)メソッドを文書化することは可能ですか?私のモジュールは、次のようになります。roxygen2を使ってRcppモジュールの公開メソッドを文書化する
RCPP_MODULE(BayesFst) {
using namespace Rcpp;
class_<BayesFst>("BayesFst")
.default_constructor("Standard constructor")
.method("printData", &BayesFst::printData)
.method("printCounts", &BayesFst::printCounts)
.method("printInitialPvals", &BayesFst::printInitialPvals)
.method("printFstSummary", &BayesFst::printFstSummary)
.method("run", &BayesFst::run)
.method("setData", &BayesFst::setData)
.method("setPriorParameters", &BayesFst::setPriorParameters)
.method("setRunParameters", &BayesFst::setRunParameters)
.method("ldiriTest", &BayesFst::ldiriTest)
.property("interaction", &BayesFst::getInteraction, &BayesFst::setInteraction)
;
}
私は理想的にこれらのメソッドのすべてを文書化したいと思います。簡単な考え方は、ラッパー関数の背後にあるクラスを隠してから、Rラッパー関数内からメソッドを呼び出すことですが、これは私にはうらやましいものです。
roxygenのコメント行を関数に追加しようとしましたが、同じ方法でエクスポートされないため、ドキュメントが選択されないようです。
新しいトピックがありますか? – yannick
いいえ、寄付は大歓迎です。おそらく[発行チケット](https://github.com/RcppCore/Rcpp/issues/617)で議論することをお勧めします。 –