DWT API Documentation now on dpldocs.info

Jacob Carlborg doob at me.com
Thu Mar 8 17:05:51 UTC 2018


On 2018-03-08 14:51, Adam D. Ruppe wrote:

> You need to go all to the way to the top level by clicking the topmost 
> link on the left nav:
> 
> http://dwt.dpldocs.info/org.html
> http://dwt.dpldocs.info/java.html

Aha, I see.

>> * No inheritance chain
>> * No implemented interfaces
> 
> They are in the prototype block
> 
> http://dwt.dpldocs.info/org.eclipse.swt.graphics.Image.Image.html
> 
> final
> class Image : Resource , Drawable {
> 
> and notice those are links so you can click up to walk the chain.

That's quite easy to miss.

> Though I didn't follow the chain all the way to the top because:
> 
>> * Only one level of inherited members
>> * I think it's a bit too much to show the documentation of inherited 
>> members, I would just have links to them
> 
> 
> These two are related. It did seem a bit silly to me to list EVERYTHING, 
> but I also figured most cases of inheritance do have at least one layer 
> of important methods.
> 
> So I compromised by showing the one, then letting you click on the links 
> in the main thing to follow the chain up.
> 
> 
> I'm open to changing that though. Like maybe it could just show 
> non-overridden members. It could walk the chain. It could skip the 
> listing and just show links all the way up to Object, perhaps under a 
> "Inheritance Chain" header so it is easier to see than the prototype.
> 
> What do you think would be best?

In general I like the what the Javadoc renders [1]:

* Separate inheritances chain
* Separate interface implementations
* Inherited members are listed as only links and the whole inheritances 
chain is included

[1] 
http://help.eclipse.org/luna/index.jsp?topic=%2Forg.eclipse.platform.doc.isv%2Freference%2Fapi%2Forg%2Feclipse%2Fswt%2Fwidgets%2Fpackage-summary.html

-- 
/Jacob Carlborg


More information about the Digitalmars-d-announce mailing list