Documentation fixes to avoid build warnings

sizespectrum · Oct 16, 2024 · 3da047f · 3da047f
1 parent 8954576
commit 3da047f
Show file tree

Hide file tree

Showing 8 changed files with 39 additions and 10 deletions.
diff --git a/R/plots.R b/R/plots.R
@@ -1403,6 +1403,10 @@ setMethod("plot", signature(x = "MizerSim", y = "missing"),
 #' level and predation mortality of each species through time. This method just
 #' uses the other plotting functions and puts them all in one window.
 #' 
+#' @param x An object of class \linkS4class{MizerParams}
+#' @param y Not used
+#' @param ...  For additional arguments see the documentation for
+#'   [plotFeedingLevel()],[plotSpectra()],[plotPredMort()]
 #' @return A viewport object
 #' @export
 #' @family plotting functions

diff --git a/R/validSpeciesParams.R b/R/validSpeciesParams.R
@@ -55,7 +55,7 @@
 #' list of these functions).
 #' 
 #' @param species_params The user-supplied species parameter data frame
-#' @return For validSpeciesParams(): A valid species parameter data frame with
+#' @return For `validSpeciesParams()`: A valid species parameter data frame with
 #'   additional parameters with default values.
 #' 
 #' @seealso [species_params()], [validGearParams()], [validParams()], [validSim()]
@@ -73,7 +73,7 @@ validSpeciesParams <- function(species_params) {
 }
 
 #' @rdname validSpeciesParams
-#' @return For validGivenSpeciesParams(): A valid species parameter data frame
+#' @return For `validGivenSpeciesParams()`: A valid species parameter data frame
 #'   without additional parameters.
 #' @export
 validGivenSpeciesParams <- function(species_params) {

diff --git a/docs/reference/completeSpeciesParams.html b/docs/reference/completeSpeciesParams.html
diff --git a/docs/reference/plot-MizerParams-missing-method.html b/docs/reference/plot-MizerParams-missing-method.html
diff --git a/docs/reference/validSpeciesParams.html b/docs/reference/validSpeciesParams.html
diff --git a/man/completeSpeciesParams.Rd b/man/completeSpeciesParams.Rd
diff --git a/man/plot-MizerParams-missing-method.Rd b/man/plot-MizerParams-missing-method.Rd
diff --git a/man/validSpeciesParams.Rd b/man/validSpeciesParams.Rd