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

(roxygen2::roxy_tag()) A roxygen2 tag to convert.

format

(character[1]) A regular expression, optionally containing named capture groups for type and description, which will be used for restructuring the tag as a roxytypes-equivalent tag.

...

Additional arguments unused.

Value

(“NULL or [tag_edit()]) If the tag can be converted, a tag_edit() is returned, otherwise 'NULL'.

Methods (by class)

See Also

Other convert: build_convert_edits(), convert_match_format(), make_convert_edits(), tag_edit()


[Package roxytypes version 0.1.1 Index]