File: roxygen.txt

package info (click to toggle)
highlight.js 10.7.3%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 8,332 kB
  • sloc: javascript: 41,059; makefile: 157; python: 29; sh: 20
file content (24 lines) | stat: -rw-r--r-- 615 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
#' A description
#'
#' Long description
#' @param x the object of type \code{numeric}
#' @return A logical indicating whether \code{x == 0}
#' @export
is_zero = function (x) x == 0

#' Sum of numbers
#'
#' \code{sum_all} is a wrapper for \code{\link{sum}(..., na.rm = TRUE)}.
#' @param ... one or more numeric vectors
#' @examples
#' sum_all(1 : 10) # 55 @this \link{should not be highlighted!}
#' sum_all(1, NA, 2, 3) # 6
#' @seealso \link[base]{sum} # this SHOULD be highlighted again.
# comment
sum_all <- function (...) {
  sum(..., na.rm = TRUE)
}

# Weird identifier in @param string

#' @param `a\`b\\` test