From 00e5a8bf6e302e9de770b9ff0a8003281409e6a1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?I=C3=B1aki=20=C3=9Acar?= Date: Tue, 8 Oct 2024 13:30:27 +0200 Subject: [PATCH] fix cross-references, closes #3 --- DESCRIPTION | 4 ++-- NEWS.md | 4 ++++ R/cppXPtr.R | 4 ++-- man/cppXPtr.Rd | 4 ++-- 4 files changed, 10 insertions(+), 6 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 0bf8e55..9604a3b 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: RcppXPtrUtils Type: Package Title: XPtr Add-Ons for 'Rcpp' -Version: 0.1.2 +Version: 0.1.2.1 Authors@R: c( person("IƱaki", "Ucar", email="iucar@fedoraproject.org", role=c("aut", "cph", "cre"), comment=c(ORCID="0000-0001-6403-5550"))) @@ -14,4 +14,4 @@ BugReports: https://github.com/Enchufa2/RcppXPtrUtils/issues Depends: R (>= 3.0.0) Imports: Rcpp Suggests: inline, testthat -RoxygenNote: 7.2.0 +RoxygenNote: 7.3.2 diff --git a/NEWS.md b/NEWS.md index 3aff3d8..e25812b 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,7 @@ +# RcppXPtrUtils devel + +- Fix cross-references in documentation (#3). + # RcppXPtrUtils 0.1.2 - Fix example. diff --git a/R/cppXPtr.R b/R/cppXPtr.R index ea59243..289321b 100644 --- a/R/cppXPtr.R +++ b/R/cppXPtr.R @@ -1,14 +1,14 @@ #' Define an \code{XPtr} with a C++ Implementation #' #' Dynamically define an \code{XPtr} with C++ source code. Compiles and links a shared -#' library with bindings to the C++ function using \code{\link{cppFunction}}, +#' library with bindings to the C++ function using \code{\link[Rcpp]{cppFunction}}, #' then returns an \code{XPtr} that points to the function and can be used to be #' plugged into another C++ backend. #' #' @inheritParams Rcpp::cppFunction #' @return An object of class \code{XPtr} that points to the compiled function. #' -#' @seealso \code{\link{cppFunction}}, \code{\link{checkXPtr}} +#' @seealso \code{\link[Rcpp]{cppFunction}}, \code{\link{checkXPtr}} #' @examples #' \donttest{ #' # takes time to compile diff --git a/man/cppXPtr.Rd b/man/cppXPtr.Rd index efe46b5..224d313 100644 --- a/man/cppXPtr.Rd +++ b/man/cppXPtr.Rd @@ -53,7 +53,7 @@ An object of class \code{XPtr} that points to the compiled function. } \description{ Dynamically define an \code{XPtr} with C++ source code. Compiles and links a shared -library with bindings to the C++ function using \code{\link{cppFunction}}, +library with bindings to the C++ function using \code{\link[Rcpp]{cppFunction}}, then returns an \code{XPtr} that points to the function and can be used to be plugged into another C++ backend. } @@ -66,5 +66,5 @@ print(ptr) } } \seealso{ -\code{\link{cppFunction}}, \code{\link{checkXPtr}} +\code{\link[Rcpp]{cppFunction}}, \code{\link{checkXPtr}} }