convert_tag {roxytypes} | R Documentation |
Convert a roxygen2
tag to roxytypes
equivalent
Description
Convert a roxygen2
tag to roxytypes
equivalent
Usage
convert_tag(tag, format, ...)
## Default S3 method:
convert_tag(tag, format, ...)
## S3 method for class 'return'
convert_tag(tag, format, ...)
## S3 method for class 'param'
convert_tag(tag, format, ...)
Arguments
tag |
( |
format |
( |
... |
Additional arguments unused. |
Value
(“NULL or [tag_edit()]
) If the tag can be converted, a tag_edit()
is returned, otherwise 'NULL'.
Methods (by class)
-
convert_tag(default)
: Default handler for tags that can not be converted. -
convert_tag(return)
: Convert@return
tags, parsing type and description from existing description. -
convert_tag(param)
: Convert@param
tags, parsing type and description from existing description.
See Also
Other convert:
build_convert_edits()
,
convert_match_format()
,
make_convert_edits()
,
tag_edit()