[lnkForumImage]
TotalShareware - Download Free Software
Confronta i prezzi di migliaia di prodotti.
Asp Forum
 Home | Login | Register | Search 


 

Forums >

comp.lang.ruby

Re: RDOC Question -- including parent class accessors, and linking other classes

SER

11/13/2004 11:19:00 AM

On Friday 12 November 2004 14:54, Dave Thomas wrote:
> RDoc doesn't currently let you do this: the problem really is knowing
> where to stop--do you document all of the parent's methods, and its
> parent's methods, and so on.
>
> I'm open to ideas here.

Hi Dave,

May I humbly suggest emulating what Javadoc does? Document the class methods,
and _list_ the ancestor methods, by class, with links to the methods. So:

class A
def a ...

class B < A
def b...

class C < B
def c

would generate, for C:

Class C
... documentation for #c ...

Methods from B
... link to #b ...

Methods from A
... link to #a ...

The methods that C answers to are clearly declared, and shown in which class
they are defined. It clutters the documentation for C minimally, as the
methods are declared, not defined.

--
### SER
### Deutsch|Esperanto|Francaise|Linux|XML|Java|Ruby|Aikido
### http://www.germane-softwar... jabber.com:ser ICQ:83578737
### GPG: http://www.germane-softwar.../Security/ser_public.gpg