[Rd] Documentation for S3 generics

Gorjanc Gregor Gregor.Gorjanc at bfro.uni-lj.si
Mon Aug 7 11:59:31 CEST 2006


Hello!

Say I have 

myMethod <- function(x, ...)
  UseMethod("myMethod")

myMethod.classA <- function(x, ...)
...

myMethod.classB <- function(x, ...)
...

myMethod.classC <- function(x, arg2, ...)
...

and I would like to properly document these as generics. Then I have to
use in usage section

\method{myMethod}{classA}(x, ...)
\method{myMethod}{classB}(x, ...)
\method{myMethod}{classC}(x, arg2, ...)

But is it really necessary to have the same documentation for myMethod.classA
and myMethod.classB? 

Lep pozdrav / With regards,
    Gregor Gorjanc

----------------------------------------------------------------------
University of Ljubljana     PhD student
Biotechnical Faculty        URI: http://www.bfro.uni-lj.si/MR/ggorjan
Zootechnical Department     mail: gregor.gorjanc <at> bfro.uni-lj.si
Groblje 3                   tel: +386 (0)1 72 17 861
SI-1230 Domzale             fax: +386 (0)1 72 17 888
Slovenia, Europe
----------------------------------------------------------------------
"One must learn by doing the thing; for though you think you know it,
 you have no certainty until you try." Sophocles ~ 450 B.C.



More information about the R-devel mailing list