tags-rd {roxygen2}R Documentation

Tags for documenting functions

Description

Learn the full details in vignette('rd').

Key tags:

Other less frequently used tags:

Usage

#' @description${1:A short description...}

#' @details${1:Additional details...}

#' @example ${1:path}.R
#' @examples${1:# example code}

#' @examplesIf ${1:condition}${2:# example code}

#' @noRd
#' @param ${1:name} ${2:description}
#' @rawRd ${1:rd}
#' @return ${1:description}
#' @returns ${1:description}
#' @title ${1:title}
#' @usage ${1:fun}(${2:arg1, arg2 = default, ...})

See Also

Other documentation tags: tags-index-crossref, tags-rd-other, tags-reuse


[Package roxygen2 version 7.3.2 Index]