klutometis/roxygen — Issue #63: Arguments order with @inheritParams
Author: sophieb
Created: 2011-11-29 14:39:44+00:00
State: open

When using @inheritParams, the arguments are not necessarily listed in the right order in the .Rd file created. By right order, I mean the argument order in the usage section.

Here is an example. Let's say I have two functions:

fct1 <- function(r, K){...}
fct2 <- function(r, p, K){...}

In the roxygen2 documentation of the first function I use the following tags:

#' @param r description of argument r
#' @param K description of argument K

For the second function, I use the following tags:

#' @param p description of argument p
#' @inheritParams fct1

After processing my code with roxygenize, the .Rd file for the function fct2 presents the arguments in the following order: p, r, K (not r, p, K as I would have expected).