Skip to content
This repository was archived by the owner on May 12, 2024. It is now read-only.

Commit ff08fe8

Browse files
committed
Add return value doc
1 parent f3a7bb8 commit ff08fe8

File tree

3 files changed

+11
-0
lines changed

3 files changed

+11
-0
lines changed

R/rdocsyntax.r

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ NULL
88

99
#' Enable syntax highlighting in R HTML documentation
1010
#'
11+
#' @return Called for side effects. No return value.
12+
#'
1113
#' @details
1214
#' R HTML help pages are rendered and served using the \link[tools:startDynamicHelp]{internal help server} (\code{httpd}).
1315
#' This function replaces the original \code{httpd} with one that receives the response from
@@ -79,9 +81,12 @@ highlight_html_docs <- function() {
7981

8082
#' Disable HTML documentation syntax highlighting
8183
#'
84+
#'
8285
#' @description
8386
#' Revert to the original help server for handling HTML documentation.
8487
#'
88+
#' @return Called for side effects. No return value.
89+
#'
8590
#' @seealso \code{\link{highlight_html_docs}}
8691
#'
8792
#' @export

man/highlight_html_docs.Rd

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/unhighlight_html_docs.Rd

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)