roxygen support on cpp side

cpp11test/R/cpp11.R

@@ -156,6 +156,63 @@ rcpp_release_ <- function(n) {
   invisible(.Call(`_cpp11test_rcpp_release_`, n))
 }
 
+notroxcpp1_ <- function(x) {
+  .Call(`_cpp11test_notroxcpp1_`, x)
+}
+
+#' @title Roxygenise C++ function II
+#' @param x numeric value
+#' @description Dummy function to test roxygen2. It adds 2.0 to a double.
+#' @export
+#' @examples roxcpp2_(1.0)
+roxcpp2_ <- function(x) {
+	.Call(`_cpp11test_roxcpp2_`, x)
+}
+
+#' @title Roxygenise C++ function III
+#' @param x numeric value
+#' @description Dummy function to test roxygen2. It adds 3.0 to a double.
+#' @export
+#' @examples roxcpp3_(1.0)
+roxcpp3_ <- function(x) {
+	.Call(`_cpp11test_roxcpp3_`, x)
+}
+
+#' @title Roxygenise C++ function IV
+#' @param x numeric value
+#' @description Dummy function to test roxygen2. It adds 4.0 to a double.
+#' @export
+#' @examples roxcpp4_(1.0)
+roxcpp4_ <- function(x) {
+	.Call(`_cpp11test_roxcpp4_`, x)
+}
+
+#' @title Roxygenise C++ function V
+#' @param x numeric value
+#' @description Dummy function to test roxygen2. It adds 5.0 to a double.
+#' @export
+#' @examples roxcpp5_(1.0)
+roxcpp5_ <- function(x) {
+	.Call(`_cpp11test_roxcpp5_`, x)
+}
+
+notroxcpp6_ <- function(x) {
+  .Call(`_cpp11test_notroxcpp6_`, x)
+}
+
+#' @title Roxygenise C++ function VII
+#' @param x numeric value
+#' @description Dummy function to test roxygen2. It adds 7.0 to a double.
+#' @export
+#' @examples
+#' my_fun <- function(x) {
+#'   roxcpp7_(x)
+#' }
+#' @seealso \code{\link{roxcpp1_}}
+roxcpp7_ <- function(x) {
+	.Call(`_cpp11test_roxcpp7_`, x)
+}
+
 cpp11_safe_ <- function(x_sxp) {
   .Call(`_cpp11test_cpp11_safe_`, x_sxp)
 }

cpp11test/src/cpp11.cpp

@@ -303,6 +303,55 @@ extern "C" SEXP _cpp11test_rcpp_release_(SEXP n) {
     return R_NilValue;
   END_CPP11
 }
+// roxygen1.cpp
+double notroxcpp1_(double x);
+extern "C" SEXP _cpp11test_notroxcpp1_(SEXP x) {
+  BEGIN_CPP11
+    return cpp11::as_sexp(notroxcpp1_(cpp11::as_cpp<cpp11::decay_t<double>>(x)));
+  END_CPP11
+}
+// roxygen1.cpp
+double roxcpp2_(double x);
+extern "C" SEXP _cpp11test_roxcpp2_(SEXP x) {
+  BEGIN_CPP11
+    return cpp11::as_sexp(roxcpp2_(cpp11::as_cpp<cpp11::decay_t<double>>(x)));
+  END_CPP11
+}
+// roxygen2.cpp
+double roxcpp3_(double x);
+extern "C" SEXP _cpp11test_roxcpp3_(SEXP x) {
+  BEGIN_CPP11
+    return cpp11::as_sexp(roxcpp3_(cpp11::as_cpp<cpp11::decay_t<double>>(x)));
+  END_CPP11
+}
+// roxygen2.cpp
+double roxcpp4_(double x);
+extern "C" SEXP _cpp11test_roxcpp4_(SEXP x) {
+  BEGIN_CPP11
+    return cpp11::as_sexp(roxcpp4_(cpp11::as_cpp<cpp11::decay_t<double>>(x)));
+  END_CPP11
+}
+// roxygen3.cpp
+double roxcpp5_(double x);
+extern "C" SEXP _cpp11test_roxcpp5_(SEXP x) {
+  BEGIN_CPP11
+    return cpp11::as_sexp(roxcpp5_(cpp11::as_cpp<cpp11::decay_t<double>>(x)));
+  END_CPP11
+}
+// roxygen3.cpp
+double notroxcpp6_(double x);
+extern "C" SEXP _cpp11test_notroxcpp6_(SEXP x) {
+  BEGIN_CPP11
+    return cpp11::as_sexp(notroxcpp6_(cpp11::as_cpp<cpp11::decay_t<double>>(x)));
+  END_CPP11
+}
+// roxygen3.cpp
+double roxcpp7_(double x);
+extern "C" SEXP _cpp11test_roxcpp7_(SEXP x) {
+  BEGIN_CPP11
+    return cpp11::as_sexp(roxcpp7_(cpp11::as_cpp<cpp11::decay_t<double>>(x)));
+  END_CPP11
+}
 // safe.cpp
 SEXP cpp11_safe_(SEXP x_sxp);
 extern "C" SEXP _cpp11test_cpp11_safe_(SEXP x_sxp) {
@@ -500,6 +549,8 @@ static const R_CallMethodDef CallEntries[] = {
     {"_cpp11test_my_warning_n1",            (DL_FUNC) &_cpp11test_my_warning_n1,            1},
     {"_cpp11test_my_warning_n1fmt",         (DL_FUNC) &_cpp11test_my_warning_n1fmt,         1},
     {"_cpp11test_my_warning_n2fmt",         (DL_FUNC) &_cpp11test_my_warning_n2fmt,         2},
+    {"_cpp11test_notroxcpp1_",              (DL_FUNC) &_cpp11test_notroxcpp1_,              1},
+    {"_cpp11test_notroxcpp6_",              (DL_FUNC) &_cpp11test_notroxcpp6_,              1},
     {"_cpp11test_protect_many_",            (DL_FUNC) &_cpp11test_protect_many_,            1},
     {"_cpp11test_protect_many_cpp11_",      (DL_FUNC) &_cpp11test_protect_many_cpp11_,      1},
     {"_cpp11test_protect_many_preserve_",   (DL_FUNC) &_cpp11test_protect_many_preserve_,   1},
@@ -518,6 +569,11 @@ static const R_CallMethodDef CallEntries[] = {
     {"_cpp11test_rcpp_sum_int_for_",        (DL_FUNC) &_cpp11test_rcpp_sum_int_for_,        1},
     {"_cpp11test_remove_altrep",            (DL_FUNC) &_cpp11test_remove_altrep,            1},
     {"_cpp11test_row_sums",                 (DL_FUNC) &_cpp11test_row_sums,                 1},
+    {"_cpp11test_roxcpp2_",                 (DL_FUNC) &_cpp11test_roxcpp2_,                 1},
+    {"_cpp11test_roxcpp3_",                 (DL_FUNC) &_cpp11test_roxcpp3_,                 1},
+    {"_cpp11test_roxcpp4_",                 (DL_FUNC) &_cpp11test_roxcpp4_,                 1},
+    {"_cpp11test_roxcpp5_",                 (DL_FUNC) &_cpp11test_roxcpp5_,                 1},
+    {"_cpp11test_roxcpp7_",                 (DL_FUNC) &_cpp11test_roxcpp7_,                 1},
     {"_cpp11test_string_proxy_assignment_", (DL_FUNC) &_cpp11test_string_proxy_assignment_, 0},
     {"_cpp11test_string_push_back_",        (DL_FUNC) &_cpp11test_string_push_back_,        0},
     {"_cpp11test_sum_dbl_accumulate2_",     (DL_FUNC) &_cpp11test_sum_dbl_accumulate2_,     1},

cpp11test/src/roxygen1.cpp

@@ -0,0 +1,22 @@
+#include "cpp11/doubles.hpp"
+using namespace cpp11;
+
+// Test: not documented + documented
+
+// Not Roxygenised C++ function I
+[[cpp11::register]] double notroxcpp1_(double x) {
+  double y = x + 1.0;
+  return y;
+}
+
+/* roxygen start
+@title Roxygenise C++ function II
+@param x numeric value
+@description Dummy function to test roxygen2. It adds 2.0 to a double.
+@export
+@examples roxcpp2_(1.0)
+roxygen end */
+[[cpp11::register]] double roxcpp2_(double x) {
+  double y = x + 2.0;
+  return y;
+}

cpp11test/src/roxygen2.cpp

@@ -0,0 +1,28 @@
+#include "cpp11/doubles.hpp"
+using namespace cpp11;
+
+// Test: documented + documented
+
+/* roxygen start
+@title Roxygenise C++ function III
+@param x numeric value
+@description Dummy function to test roxygen2. It adds 3.0 to a double.
+@export
+@examples roxcpp3_(1.0)
+roxygen end */
+[[cpp11::register]] double roxcpp3_(double x) {
+  double y = x + 3.0;
+  return y;
+}
+
+/* roxygen start
+@title Roxygenise C++ function IV
+@param x numeric value
+@description Dummy function to test roxygen2. It adds 4.0 to a double.
+@export
+@examples roxcpp4_(1.0)
+roxygen end */
+[[cpp11::register]] double roxcpp4_(double x) {
+  double y = x + 4.0;
+  return y;
+}

cpp11test/src/roxygen3.cpp

@@ -0,0 +1,38 @@
+#include "cpp11/doubles.hpp"
+using namespace cpp11;
+
+// Test: documented + not documented + documented
+
+/* roxygen start
+@title Roxygenise C++ function V
+@param x numeric value
+@description Dummy function to test roxygen2. It adds 5.0 to a double.
+@export
+@examples roxcpp5_(1.0)
+roxygen end */
+[[cpp11::register]] double roxcpp5_(double x) {
+  double y = x + 5.0;
+  return y;
+}
+
+// Not Roxygenised C++ function VI
+[[cpp11::register]] double notroxcpp6_(double x) {
+  double y = x + 6.0;
+  return y;
+}
+
+/* roxygen start
+@title Roxygenise C++ function VII
+@param x numeric value
+@description Dummy function to test roxygen2. It adds 7.0 to a double.
+@export
+@examples
+my_fun <- function(x) {
+  roxcpp7_(x)
+}
+@seealso \code{\link{roxcpp1_}}
+roxygen end */
+[[cpp11::register]] double roxcpp7_(double x) {
+  double y = x + 7.0;
+  return y;
+}