[Roxygen-devel] Share documentation for multiple parameters

[Andreas Alfons]

Hi everybody,

I had the idea to add a keyword to roxygen2 that would allow to share
documentation for some parameters. My suggestion was to use something
like

@multiParam 3 las mar oma  graphics parameters

but the syntax isn't very nice (there's a new keyword and you have to
specify the number of arguments that share the documentation).

Hadley would prefer something along the lines of

@param {las mar oma}  graphics parameters

What do the roxygen users think? Any other suggestions?

Andreas


P.S.: I'm aware of the workaround

@param las,mar,oma  graphics parameters

but that doesn't give you spaces between the arguments in the R help file.


-- 
Andreas Alfons
Faculty of Business and Economics, K.U.Leuven
www.econ.kuleuven.be/andreas.alfons/public/