Rcpp 在两个函数之间共享相同的 roxygen

Question

考虑以下函数：

//' Provides some stuff AB
//' @param a integer that responsible for stuff A
//' @param b integer that responsible for stuff B
//' @export
// [[Rcpp::export]]
NumericVector foo1(int a, int b)
{
   //some code
}

//' Provides some stuff AC
//' @param a integer that responsible for stuff A
//' @param c integer that responsible for stuff C
//' @export
// [[Rcpp::export]]
NumericVector foo2(int a, int c)
{
   //some code
}

注意参数a描述对于foo1和foo2应该是一样的。我有很多函数，其中 a 参数说明应该以相同的方式提供。我不想在每次需要每个函数时分别复制过去的 a 参数说明。是否可以指定 a 描述并将其应用于我的 Rcpp 包提供的所有功能？

非常感谢您的帮助！

Answer 1

感谢 Dirk Eddelbuettel，我找到了答案：

//' @name sharable
//' @rdname sharable
//' @param a integer that responsible for stuff A
//' @export

//' Provides some stuff AB
//' @rdname sharable
//' @param b integer that responsible for stuff B
//' @export
// [[Rcpp::export]]
NumericVector foo1(int a, int b)
{
   //some code
}

//' Provides some stuff AC
//' @rdname sharable
//' @param c integer that responsible for stuff C
//' @export
// [[Rcpp::export]]
NumericVector foo2(int a, int c)
{
   //some code
}

Rcpp 在两个函数之间共享相同的 roxygen

Rcpp share same roxygen between two functions

r

roxygen

rcpp

roxygen2

rcpp11