UsageTag-class: @usage: describe the usage of a function.

Description Tag Usage

Description

Roxygen3 will automatically generate the usage string for you - if you need specify this yourself (unless you particularly want to control the formatting it's probably an indiciation of roxygen bug and should be reported).

Tag Usage

1
#' @usage f(a, b, c) # You can also comments

hadley/roxygen3 documentation built on May 17, 2019, 12:16 p.m.