16.6 Re-using documentation
16.6.1 Multiple functions
@rdname
: document multiple functions in one place that have a lot in common
- Use with caution. Can lead to confusing documentation.
16.6.2 Inheriting documentation
@inherit source_function
will inherit all supported components fromsource_function()
.@inheritSection source_function Section title
will inherit the single section with title “Section title” fromsource_function()
.@inheritDotParams
automatically generates parameter documentation for...
for the common case where you pass...
on to another function.