default_format: Default formatter for @typed
In roxytypes: Typed Parameter Tags for Integration with 'roxygen2'
default_format R Documentation
Default formatter for @typed
Description
Adds special cases for when the type uses other roxygen2 syntax
Usage
default_format(x, name, type, description, ...)
Arguments
x
(roxygen2::roxy_tag()) The tag to format.
name, type, description
(character(1)) Fields parsed from the @typed tag.
...
Additional arguments unused.
Value
A formatted character value.
roxytypes documentation built on Oct. 16, 2024, 1:06 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| default_format | R Documentation |
Default formatter for @typed
Description
Adds special cases for when the type uses other roxygen2 syntax
Usage
default_format(x, name, type, description, ...)
Arguments
x |
( |
name, type, description |
( |
... |
Additional arguments unused. |
Value
A formatted character value.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.