correct @return parsing

Author: pachadotdev

R/register.R

@@ -1,6 +1,6 @@
-#' Generates wrappers for registered C++ functions
+#' @title Generates wrappers for registered C++ functions
 #'
-#' Functions decorated with `[[cpp4r::register]]` in files ending in `.cc`,
+#' @description Functions decorated with `[[cpp4r::register]]` in files ending in `.cc`,
 #' `.cpp`, `.h` or `.hpp` will be wrapped in generated code and registered to
 #' be called from R.
 #'
@@ -9,7 +9,8 @@
 #'
 #' In order to use `register()` the `cli`, `decor`, `desc`, `glue`,
 #' `tibble` and `vctrs` packages must also be installed.
-#' @param path The path to the package root directory. The default is \code{NULL},
+#' 
+#' @param path The path to the package root directory. The default is `NULL`,
 #' @param quiet If `TRUE` suppresses output from this function
 #' @param extension The file extension to use for the generated src/cpp4r file.
 #'   `.cpp` by default, but `.cc` is also supported.

R/template.R

@@ -1,6 +1,12 @@
 # The function itself just echos its inputs and outputs to a file called INDEX,
 # which is then opened by RStudio when the new project is opened.
-#' Start a new project with the cpp4r package template
+
+#' @title Start a new project with the cpp4r package template
+#' 
+#' @description This function copies a package template into a new directory.
+#' The template includes a DESCRIPTION file, a minimal R/ directory and placeholders
+#' with instructions. You can then edit these files to customize your new package.
+#' 
 #' @param path Path to the new project
 #' @param pkgname Name of the new package
 #' @return The file path to the copied template (invisibly).

R/unvendor.R

@@ -3,8 +3,8 @@
 #' This function removes the vendored cpp4r headers from your package by
 #' automatically finding the vendored headers.
 #'
-#' @param path The directory with the vendored headers. It is recommended to use \code{"./src/vendor"}.
-#' The default is \code{NULL}.
+#' @param path The directory with the vendored headers. It is recommended to use `"./src/vendor"`.
+#' The default is `NULL`.
 #' @return The path to the unvendored code (invisibly).
 #' @export
 #' @examples

R/vendor.R

@@ -1,6 +1,6 @@
-#' Vendor the cpp4r headers
+#' @title Vendor the cpp4r headers
 #'
-#' Vendoring is the act of making your own copy of the 3rd party packages your
+#' @description Vendoring is the act of making your own copy of the 3rd party packages your
 #' project is using. It is often used in the go language community.
 #'
 #' This function vendors cpp4r into your package by copying the cpp4r

docs/content.css

@@ -437,3 +437,18 @@ mjx-container[jax="SVG"]:not([display="true"]) {
   margin: 0;
   color: #dc3545;
 }
+
+/* References section styling */
+#refs.references {
+  margin-bottom: 2em;
+}
+
+#refs.references .csl-entry {
+  margin-bottom: 1em;
+  padding-bottom: 0.5em;
+}
+
+/* Add extra spacing for the last reference entry */
+#refs.references .csl-entry:last-child {
+  margin-bottom: 1.5em;
+}

docs/index.html

@@ -73,17 +73,22 @@
 <div id="content">
 <div class="content-wrapper">
 <div class="content-main">
-<p># cpp4r</p>
 
-<p><a href="https://lifecycle.r-lib.org/articles/stages.html#stable"><img src="https://img.shields.io/badge/lifecycle-stable-brightgreen.svg" alt="Lifecycle:
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
+<h1>cpp4r</h1>
+
+<!-- badges: start -->
+
+<a href="https://lifecycle.r-lib.org/articles/stages.html#stable"><img src="https://img.shields.io/badge/lifecycle-stable-brightgreen.svg" alt="Lifecycle:
 stable"></a>
 <a href="https://github.com/pachadotdev/cpp4r/actions/workflows/R-CMD-check.yaml"><img src="https://github.com/pachadotdev/cpp4r/actions/workflows/R-CMD-check.yaml/badge.svg" alt="R-CMD-check"></a>
 <a href="https://CRAN.R-project.org/package=cpp4r"><img src="https://www.r-pkg.org/badges/version/cpp4r" alt="CRAN
 status"></a>
 <a href="https://github.com/pachadotdev/cpp4r/actions/workflows/test-coverage.yaml"><img src="https://raw.githubusercontent.com/pachadotdev/cpp4r/coverage/badges/coverage.svg" alt="Test
 coverage"></a>
 <a href="https://buymeacoffee.com/pacha"><img src="https://raw.githubusercontent.com/pachadotdev/buymeacoffee-badges/main/bmc-yellow.svg" alt="BuyMeACoffee"></a>
-<!-- badges: end --></p>
+<!-- badges: end -->
 
 <p>cpp4r helps you to interact with R objects using C++ code. It is a fork
 of the <a href="https://cran.r-project.org/package=cpp11">cpp11</a> package with
@@ -109,13 +114,12 @@
 <li><input type="checkbox" checked disabled> Support bidirectional passing of complex numbers/vectors.</li>
 <li><input type="checkbox" checked disabled> Provide flexibility with data types (e.g., cpp4r’s <code>as_integers()</code> and <code>as_doubles()</code> accept logical inputs while cpp11’s do not).</li>
 <li><input type="checkbox" checked disabled> Some internal optimizations for better speed (e.g., <a href="https://github.com/r-lib/cpp11/pull/463">https://github.com/r-lib/cpp11/pull/463</a> and <a href="https://github.com/r-lib/cpp11/pull/430">https://github.com/r-lib/cpp11/pull/430</a>).</li>
-</ul>
-## Getting started
+</ul><h2>Getting started</h2>
 
 <p>Check the <a href="https://cpp4r.org/">documentation</a> to get started using cpp4r
 in your scripts, particularly if you are new to C++ programming.</p>
 
-<p>## Using cpp4r in a package</p>
+<h2>Using cpp4r in a package</h2>
 
 <p>Create a new package with <code>cpp4r::pkg_template("~/path/to/mypkg")</code> and
 then edit the generated files.</p>
@@ -138,7 +142,7 @@
 use a shared library. It is straightforward and reliable to use in
 packages without fear of compile-time and run-time mismatches.</p>
 
-<p>## Vendoring</p>
+<h2>Vendoring</h2>
 
 <p>You can <a href="https://cpp4r.org/articles/01-motivations.html">vendor</a> the
 current installed version of cpp4r headers into your package with
@@ -154,24 +158,24 @@
 that you will not get bug fixes and new features unless you update the
 vendored headers.</p>
 
-<p>## Getting help</p>
+<h2>Getting help</h2>
 
 <p>Please open an issue or email me. I will do my best to respond before 48
 hours.</p>
 
-<p>## Contributing</p>
+<h2>Contributing</h2>
 
 <p>Contributions are welcome! Please see the <a href="https://cpp4r.org/articles/15-internals.html">internals
 vignette</a> for details
 about design choices and coding style.</p>
 
-<p>## Code of Conduct</p>
+<h2>Code of Conduct</h2>
 
 <p>Please note that the cpp4r project is released with a <a href="https://cpp4r.org/CODE_OF_CONDUCT.html">Contributor Code
 of Conduct</a>. By contributing to
 this project, you agree to abide by its terms.</p>
 </div>
-<footer><p>Last updated: 2025-10-12 19:45:53</p>
+<footer><p>Last updated: 2025-10-12 22:30:17</p>
 </footer><script>
 document.addEventListener('DOMContentLoaded', function() {
   // Theme toggle functionality

docs/news/index.html

@@ -74,23 +74,21 @@
 <div class="content-wrapper">
 <div class="content-main">
 <h1>Changelog</h1>
-<p># cpp4r 0.3.0</p>
+<h1>cpp4r 0.3.0</h1>
 
 <ul><li>Added <code>as_logicals()</code> and <code>as_strings()</code> in the same style of <code>as_doubles()</code> and <code>as_integers()</code></li>
 <li>Improved memory management for <code>r_vector</code> iterators</li>
 <li>Slightly faster than <code>cpp11</code></li>
 <li><code>vendor()</code> and <code>unvendor()</code> use <code>path = NULL</code> as default to adhere to CRAN policies.</li>
-</ul>
-# cpp4r 0.2.0
+</ul><h1>cpp4r 0.2.0</h1>
 
 <ul><li>Reduced dependencies on R side</li>
 <li>The vignettes are rendered only for the package site to keep the CRAN build minimal</li>
-</ul>
-# cpp4r 0.1.0
+</ul><h1>cpp4r 0.1.0</h1>
 
 <ul><li>Initial release</li>
 </ul></div>
-<footer><p>Last updated: 2025-10-12 19:46:01</p>
+<footer><p>Last updated: 2025-10-12 22:30:25</p>
 </footer><script>
 document.addEventListener('DOMContentLoaded', function() {
   // Theme toggle functionality

docs/reference/index.html

@@ -78,7 +78,7 @@ <h1>Function Reference</h1>
 <li><a href="pkg_template.html">pkg_template</a></li>
 <li><a href="unvendor.html">unvendor</a></li>
 <li><a href="vendor.html">vendor</a></li></ul></div>
-<footer><p>Last updated: 2025-10-12 19:45:53</p>
+<footer><p>Last updated: 2025-10-12 22:30:17</p>
 </footer><script>
 document.addEventListener('DOMContentLoaded', function() {
   // Theme toggle functionality

docs/reference/pkg_template.html

@@ -73,18 +73,23 @@
 <div id="content">
 <div class="content-wrapper">
 <div class="content-main">
-<h1></h1>
+<h1>Start a new project with the cpp4r package template </h1>
+<h2>Description</h2>
+<p>The template includes a DESCRIPTION file, a minimal R/ directory and placeholders
+with instructions. You can then edit these files to customize your new package.</p>
 <h2>Arguments</h2>
-<table class="ref-arguments"><tbody><tr><td><strong>path</strong></td><td>Path to the new project</td></tr><tr><td><strong>pkgname</strong></td><td>Name of the new package</td></tr></tbody></table><h2>Examples</h2>
+<table class="ref-arguments"><tbody><tr><td><strong>path</strong></td><td>Path to the new project</td></tr><tr><td><strong>pkgname</strong></td><td>Name of the new package</td></tr></tbody></table><h2>Return</h2>
+<p>The file path to the copied template (invisibly).</p>
+<h2>Examples</h2>
 <div class="sourceCode"><pre><code># create a new directory
 dir &lt;- tempdir()
 dir.create(dir)</code></pre></div>
 <div class="output"><pre><code>## [1] FALSE</code></pre></div>
 <div class="sourceCode"><pre><code># copy the package template into the directory
 pkg_template(dir, "mynewpkg")</code></pre></div>
-<div class="output"><pre><code>## [1] "/tmp/RtmpD7okxS"</code></pre></div>
+<div class="output"><pre><code>## [1] "/tmp/RtmpXU10wP"</code></pre></div>
 </div>
-<footer><p>Last updated: 2025-10-12 19:45:53</p>
+<footer><p>Last updated: 2025-10-12 22:30:18</p>
 </footer><script>
 document.addEventListener('DOMContentLoaded', function() {
   // Theme toggle functionality

docs/reference/register.html

@@ -73,9 +73,18 @@
 <div id="content">
 <div class="content-wrapper">
 <div class="content-main">
-<h1></h1>
+<h1>Generates wrappers for registered C++ functions </h1>
+<h2>Description</h2>
+<code>.cpp</code>, <code>.h</code> or <code>.hpp</code> will be wrapped in generated code and registered to
+be called from R.
+<p>Note registered functions will not be *exported* from your package unless
+you also add a <code>@export</code> roxygen2 directive for them.</p>
+<p>In order to use <code>register()</code> the <code>cli</code>, <code>decor</code>, <code>desc</code>, <code>glue</code>,
+<code>tibble</code> and <code>vctrs</code> packages must also be installed.</p>
 <h2>Arguments</h2>
-<table class="ref-arguments"><tbody><tr><td><strong>path</strong></td><td>The path to the package root directory. The default is \code{NULL},</td></tr><tr><td><strong>quiet</strong></td><td>If <code>TRUE</code> suppresses output from this function</td></tr><tr><td><strong>extension</strong></td><td>The file extension to use for the generated src/cpp4r file.</td></tr></tbody></table><h2>Examples</h2>
+<table class="ref-arguments"><tbody><tr><td><strong>path</strong></td><td>The path to the package root directory. The default is <code>NULL</code>,</td></tr><tr><td><strong>quiet</strong></td><td>If <code>TRUE</code> suppresses output from this function</td></tr><tr><td><strong>extension</strong></td><td>The file extension to use for the generated src/cpp4r file. <code>.cpp</code> by default, but <code>.cc</code> is also supported.</td></tr></tbody></table><h2>Return</h2>
+<p>The paths to the generated R and C++ source files (in that order).</p>
+<h2>Examples</h2>
 <div class="sourceCode"><pre><code># create a minimal package
 dir &lt;- tempfile()
 dir.create(dir)</code></pre></div>
@@ -87,8 +96,8 @@ <h2>Arguments</h2>
 writeLines("[[cpp4r::register]] int one() { return 1; }", file.path(dir, "src", "one.cpp"))</code></pre></div>
 <div class="sourceCode"><pre><code># register the functions in the package
 register(dir)</code></pre></div>
-<div class="output"><pre><code>## [1] "/tmp/RtmpD7okxS/file7aa8f1fd38b08/R/cpp4r.R"
-## [2] "/tmp/RtmpD7okxS/file7aa8f1fd38b08/src/cpp4r.cpp"</code></pre></div>
+<div class="output"><pre><code>## [1] "/tmp/RtmpXU10wP/file9555e5f74611a/R/cpp4r.R"
+## [2] "/tmp/RtmpXU10wP/file9555e5f74611a/src/cpp4r.cpp"</code></pre></div>
 <div class="sourceCode"><pre><code># Files generated by registration
 file.exists(file.path(dir, "R", "cpp4r.R"))
 file.exists(file.path(dir, "src", "cpp4r.cpp"))</code></pre></div>
@@ -97,7 +106,7 @@ <h2>Arguments</h2>
 unlink(dir, recursive = TRUE)</code></pre></div>
 <div class="output"><pre><code>## [1] 0</code></pre></div>
 </div>
-<footer><p>Last updated: 2025-10-12 19:45:53</p>
+<footer><p>Last updated: 2025-10-12 22:30:17</p>
 </footer><script>
 document.addEventListener('DOMContentLoaded', function() {
   // Theme toggle functionality