[R] documenting R reference class methods with roxygen2

Witold E Wolski wewolski at gmail.com
Wed Jul 20 10:26:26 CEST 2016


I would like to document function arguments in R reference classes and
I do not know how.

I know that methods description can be provided by adding
a string below the function declaration. But how to document the
function arguments in similar fashion like the arguments of R
functions (which can be documented with @param).

Thank you.

PS. Sorry if for some this question is off topic but I did not found a
mailing list dedicated to roxygen2.



-- 
Witold Eryk Wolski



More information about the R-help mailing list