Add return value doc

kiendang · Apr 2, 2021 · ff08fe8 · ff08fe8
1 parent f3a7bb8
commit ff08fe8
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 0 deletions.
diff --git a/R/rdocsyntax.r b/R/rdocsyntax.r
@@ -8,6 +8,8 @@ NULL
 
 #' Enable syntax highlighting in R HTML documentation
 #'
+#' @return Called for side effects. No return value.
+#'
 #' @details
 #' R HTML help pages are rendered and served using the \link[tools:startDynamicHelp]{internal help server} (\code{httpd}).
 #' This function replaces the original \code{httpd} with one that receives the response from
@@ -79,9 +81,12 @@ highlight_html_docs <- function() {
 
 #' Disable HTML documentation syntax highlighting
 #'
+#'
 #' @description
 #' Revert to the original help server for handling HTML documentation.
 #'
+#' @return Called for side effects. No return value.
+#'
 #' @seealso \code{\link{highlight_html_docs}}
 #'
 #' @export

diff --git a/man/highlight_html_docs.Rd b/man/highlight_html_docs.Rd
diff --git a/man/unhighlight_html_docs.Rd b/man/unhighlight_html_docs.Rd