roxy_tag {roxygen2} | R Documentation |
roxy_tag
S3 constructor
Description
roxy_tag()
is the constructor for tag objects.
roxy_tag_warning()
is superseded by warn_roxy_tag()
; use to generate a
warning that includes the location of the tag.
Usage
roxy_tag(tag, raw, val = NULL, file = NA_character_, line = NA_character_)
roxy_tag_parse(x)
roxy_tag_warning(x, ...)
warn_roxy_tag(tag, message, ...)
Arguments
tag |
Tag name. Arguments starting with |
raw |
Raw tag value, a string. |
val |
Parsed tag value, typically a character vector, but sometimes
a list. Usually filled in by |
file , line |
Location of the tag |
x |
A tag |
Methods
Define a method for roxy_tag_parse
to support new tags. See tag_parsers
for more details.
[Package roxygen2 version 7.2.3 Index]