Typed Parameter Tags for Integration with 'roxygen2'
Find an associated block
Build a collection of conversion edits
Convert a roxygen2 tag to roxytypes equivalent
Built a conversion edit
Fetch roxygen2 blocks
Split and trim a string
Build format regular expression
Clear state object
Configuration
roxytypes Config
Tools for modifying configuration files
Conversion Helpers
Match a conversion format and structure results
Convert roxygen2 tags to roxytypes tags
Default formatter for @typed
Find package root directory
If-not-null-else
Make tag edits
A helper to reliably read DCF files
Capture regex groups
A half-baked extract method
roxygen2 @typed tag parsing
roxygen2 @typedreturn tag parsing
roxygen2 @typed tag rd section population
roxygen2 @typedreturn tag rd section population
roxytypes tags
Parse a raw @typed tag
Parse a raw @typedreturn tag
roxygen2 @typedreturn tag
vapply helpers
A helper to apply field names to all roxy_tag val fields
Provides typed parameter documentation tags for integration with 'roxygen2'. Typed parameter tags provide a consistent interface for annotating expected types for parameters and returned values. Tools for converting from existing styles are also provided to easily adapt projects which implement typed documentation by convention rather than tag. Use the default format or provide your own.
Useful links