Add missing value documentations
For:
* hc_add_onclick_korap_search
* hc_freq_by_year_ci
Change-Id: If07e50205bafb705fd5411f6e7f9106cb3d49923
diff --git a/R/hc_add_onclick_korap_search.R b/R/hc_add_onclick_korap_search.R
index b5c57b2..6d1508e 100644
--- a/R/hc_add_onclick_korap_search.R
+++ b/R/hc_add_onclick_korap_search.R
@@ -10,7 +10,8 @@
#'
#' @family highcharter-helpers
#'
-#' @param hc higchart object
+#' @param hc A highchart htmlwidget object generated by e.g. [frequencyQuery()].
+#' @return The input highchart object with added on-click events.
#' @export
#'
#' @examples
diff --git a/R/hc_freq_by_year_ci.R b/R/hc_freq_by_year_ci.R
index 2b54cb3..6ea3da9 100644
--- a/R/hc_freq_by_year_ci.R
+++ b/R/hc_freq_by_year_ci.R
@@ -18,6 +18,8 @@
#' @param smooth boolean decides whether the graph is smoothed using the highcharts plot types spline and areasplinerange.
#' @param ... additional arguments passed to [hc_add_series()]
#'
+#' @return A highchart htmlwidget object containing the frequency plot.
+#'
#' @examples
#' \dontrun{
#'
diff --git a/man/hc_add_onclick_korap_search.Rd b/man/hc_add_onclick_korap_search.Rd
index 0c56f9a..925c5f7 100644
--- a/man/hc_add_onclick_korap_search.Rd
+++ b/man/hc_add_onclick_korap_search.Rd
@@ -7,7 +7,10 @@
hc_add_onclick_korap_search(hc)
}
\arguments{
-\item{hc}{higchart object}
+\item{hc}{A highchart htmlwidget object generated by e.g. \code{\link[=frequencyQuery]{frequencyQuery()}}.}
+}
+\value{
+The input highchart object with added on-click events.
}
\description{
\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}}
diff --git a/man/hc_freq_by_year_ci.Rd b/man/hc_freq_by_year_ci.Rd
index e8e560e..695a942 100644
--- a/man/hc_freq_by_year_ci.Rd
+++ b/man/hc_freq_by_year_ci.Rd
@@ -23,6 +23,9 @@
\item{...}{additional arguments passed to \code{\link[=hc_add_series]{hc_add_series()}}}
}
+\value{
+A highchart htmlwidget object containing the frequency plot.
+}
\description{
\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}}