roxygen: add return value documentation

lschneiderbauer · Dec 27, 2024 · 028e20d · 028e20d
1 parent c164605
commit 028e20d
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 0 deletions.
diff --git a/R/fcwtr_scalogram.R b/R/fcwtr_scalogram.R
@@ -262,6 +262,8 @@ rbind.fcwtr_scalogram <- function(...) {
 #' @param x The "fcwtr_scalogram" object resulting from [fcwt()] to print.
 #' @inheritParams base::print
 #'
+#' @return Returns the argument `x` invisibly.
+#'
 #' @export
 print.fcwtr_scalogram <- function(x, ...) {
   cat("_Scalogram_\n")
@@ -342,6 +344,8 @@ as.data.frame.fcwtr_scalogram <- function(x, ...) {
 #'  An "fcwtr_scalogram" object resulting from [fcwt()].
 #' @inheritParams base::as.matrix
 #'
+#' @return A two dimensional numeric vector, inheriting the S3 class "matrix".
+#'
 #' @examples
 #' fcwt(
 #'   sin((1:5000) * 2 * pi * 440 / 44100),

diff --git a/man/as.matrix.fcwtr_scalogram.Rd b/man/as.matrix.fcwtr_scalogram.Rd
diff --git a/man/print.fcwtr_scalogram.Rd b/man/print.fcwtr_scalogram.Rd