[Roxygen-devel] documenting function signatures

[Hadley Wickham]

> I am looking for a way to formally describe an R function/method and its
> signature. I recently discovered roxygen and I like what I see so far.
> However, the examples I found only use "@parameter [name] [description]". Is
> there a way to also include things like the class or length of a parameter
> in the doc, other than informally describing them?

Not that I'm aware of.  A common convention is to provide a link to
the documentation of the class involved.

Hadley

-- 
Assistant Professor / Dobelman Family Junior Chair
Department of Statistics / Rice University
http://had.co.nz/