View mode: basic / threaded / horizontal-split · Log in · Help
May 16, 2007
Better documentation generation
One thing I'd really like to see in the documentation generated by ddoc is:
- for an interface: the superinterfaces[1], the known subinterfaces and 
the known classes implementing it
- for a class: the superclass[1] and the known subclasses

While browsing documentation, this is very useful for picking a 
particular implementation of an interface (i.e. which List should I use? 
ArrayList? LinkedList? etc.). Is it hard to implement?

Regards,
Ary

[1] While these are already shown, there is no link to go to their 
documentation.
May 16, 2007
Re: Better documentation generation
Ary Manzana wrote:

> One thing I'd really like to see in the documentation generated by ddoc
> is: - for an interface: the superinterfaces[1], the known subinterfaces
> and the known classes implementing it
> - for a class: the superclass[1] and the known subclasses
> 
> While browsing documentation, this is very useful for picking a
> particular implementation of an interface (i.e. which List should I use?
> ArrayList? LinkedList? etc.). Is it hard to implement?
> 
> Regards,
> Ary
> 
> [1] While these are already shown, there is no link to go to their
> documentation.

I believe Gregor accepts patches for the DDoc part of the frontend such that
he can expand the DDoc support via rebuild. Probably a much quicker path
than waiting for Walter. There already are several outstanding ddoc bugs
afaik.

-- 
Lars Ivar Igesund
blog at http://larsivi.net
DSource, #d.tango & #D: larsivi
Dancing the Tango
Top | Discussion index | About this forum | D home