Descent generated documentation

Steven Schveighoffer schveiguy at yahoo.com
Fri Jul 10 13:23:57 PDT 2009


On Fri, 10 Jul 2009 10:05:38 -0400, Steven Schveighoffer  
<schveiguy at yahoo.com> wrote:

> One preference, if it's possible, is to copy the description of  
> inherited methods from the base class.  Even if not the entire  
> documentation, just a summary, first sentence from the documentation.
>
> Already it's better than ddoc.  Nice work!


More nitpicks:

You specify where a method is inherited from multiple times, i.e.  
tango.io.FileConduit inherits close from DeviceConduit, Conduit, and  
IConduit.  And methods overridden still list those methods as inherited.

1. Abstract methods aren't "Inherited", they are implemented, so abstract  
and interface methods shouldn't be listed as inherited methods.
2. Overridden methods aren't inherited, they are overridden, those should  
be listed differently.

All that would be easier, if all methods were listed inline with the  
appropriate attributions afterwards.  i.e.: (/italics/)

void close() /inherited from DeviceConduit/
uint write(void[] buf) /overrides DeviceConduit.write, implements  
OutputStream.write/

You must have expected this firestorm of requests :)  People have been  
complaining about the deficiencies of ddoc for a long time, but nobody's  
every really improved it.

-Steve


More information about the Digitalmars-d-announce mailing list