Add return values to ggplot2 theme docs

R/ggplot2.R

@@ -26,6 +26,7 @@
 #'     theme_xaringan()
 #' }
 #'
+#' @return A ggplot2 theme
 #' @family xaringanthemer ggplot2 themes
 #' @export
 theme_xaringan <- function(
@@ -75,6 +76,7 @@ theme_xaringan <- function(
 #'     theme_xaringan()
 #' }
 #'
+#' @return A ggplot2 theme
 #' @family xaringanthemer ggplot2 themes
 #' @export
 theme_xaringan_inverse <- function(
@@ -164,6 +166,7 @@ theme_xaringan_inverse <- function(
 #'            caption = "{xaringanthemer}")
 #' }
 #'
+#' @return A ggplot2 theme
 #' @family xaringanthemer ggplot2 themes
 #' @export
 theme_xaringan_base <- function(
@@ -243,6 +246,7 @@ theme_xaringan_base <- function(
 #'
 #' @family xaringanthemer ggplot2 themes
 #' @inheritParams theme_xaringan
+#' @return Invisibly returns a list of the current ggplot2 geom defaults
 #' @export
 theme_xaringan_set_defaults <- function(
   text_color = NULL,
@@ -313,6 +317,7 @@ theme_xaringan_set_defaults <- function(
 
 #' @describeIn theme_xaringan_set_defaults Restore previous or standard [ggplot2] _geom_ defaults.
 #' @inheritParams theme_xaringan
+#' @return Invisibly returns a list of the current ggplot2 geom defaults
 #' @export
 xaringan_theme_restore_defaults <- function() {
   requires_package("ggplot2")

man/theme_xaringan.Rd

@@ -47,6 +47,9 @@ defaults to 11.}
 or defaults to 14.}
 }}
 }
+\value{
+A ggplot2 theme
+}
 \description{
 Creates \link{ggplot2} themes to match the xaringanthemer theme used in the
 \link{xaringan} slides that seamlessly matches the "normal" slide colors and

man/theme_xaringan_base.Rd

@@ -49,6 +49,9 @@ defaults to 11.}
 \item{title_font_size}{Base text font size, inherits from \code{title_font_size},
 or defaults to 14.}
 }
+\value{
+A ggplot2 theme
+}
 \description{
 Provides a base plot theme for \link{ggplot2} to match the \link{xaringan} slide theme
 created by \link{xaringanthemer}. The theme is designed to create a general plot

man/theme_xaringan_inverse.Rd

@@ -47,6 +47,9 @@ defaults to 11.}
 or defaults to 14.}
 }}
 }
+\value{
+A ggplot2 theme
+}
 \description{
 A \link{ggplot2} xaringanthemer plot theme to seamlessly match the "inverse"
 \link{xaringan} slide colors and styles as styled by \link{xaringanthemer}.

man/theme_xaringan_set_defaults.Rd

@@ -23,6 +23,11 @@ xaringan_theme_restore_defaults()
 \item{accent_secondary_color}{Color for secondary accents, inherits from
 \code{text_bold_color}}
 }
+\value{
+Invisibly returns a list of the current ggplot2 geom defaults
+
+Invisibly returns a list of the current ggplot2 geom defaults
+}
 \description{
 Set \link{ggplot2} \emph{geom} defaults to match \code{\link[=theme_xaringan]{theme_xaringan()}} with
 \code{theme_xaringan_set_defaults()} and restore the standard or previously-set