roxygen3 (version 0.1)

InheritParamsTag-class: @inheritParams: Inherit parameters from another function.

Description

This tag will bring in all documentation for parameters that are undocumented in the current function, but documented in the source function. The source can be a function in the current package, function, or another package package::function.

Arguments

Tag Usage

#' @inheritParams local_function
#'  @inheritParams package::remote_function

Details

You may use multiple @inheritParams tags to inherit parameters from multiple functions.