From: "Sean E. Russell" <ggg@...1.net>
Date: 2004-11-13T20:18:48+09:00
Subject: Re: RDOC Question -- including parent class accessors, and linking other classes

--nextPart2934683.YtAqJmq5sL
Content-Type: text/plain;
  charset="utf-8"
Content-Transfer-Encoding: quoted-printable
Content-Disposition: inline

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 metho=
ds,=20
and _list_ the ancestor methods, by class, with links to the methods.  So:

 class A
   def a ...
=20
 class B < A
   def b...
=20
 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 clas=
s=20
they are defined.  It clutters the documentation for C minimally, as the=20
methods are declared, not defined.

=2D-=20
### SER  =20
### Deutsch|Esperanto|Francaise|Linux|XML|Java|Ruby|Aikido
### http://www.germane-software.com/~ser  jabber.com:ser  ICQ:83578737=20
### GPG: http://www.germane-software.com/~ser/Security/ser_public.gpg

--nextPart2934683.YtAqJmq5sL
Content-Type: application/pgp-signature

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.6 (GNU/Linux)

iD8DBQBBle2UP0KxygnleI8RAgJ/AJ9NZcMb2EKfO2+6nvTavEydii1GcwCfaJgz
IpLLVtNa1Pxf4kcfl3QEQaM=
=v/zS
-----END PGP SIGNATURE-----

--nextPart2934683.YtAqJmq5sL--