Re: DWT API Documentation now on dpldocs.info
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
Re: DWT API Documentation now on dpldocs.info
On Thursday, 8 March 2018 at 08:25:10 UTC, Jacob Carlborg wrote: * It doesn't seem to be possible to navigate between the top level packages, i.e. "java" and "org" 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 Though, I see when you click on "org" it takes you right into "org.eclipse"... that's a side effect of the single-item module (when you click on foo.bar and it only has one member, it goes straight to that member to handle these java-like one class per module layouts... but I guess I buggily applied it to modules too.) * 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. tho on that page i see a javadoc @link that didn't get translated... i can fix that later. 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?
Re: DWT API Documentation now on dpldocs.info
On Thursday, 8 March 2018 at 01:21:44 UTC, Adam D. Ruppe wrote: As some of you might know, DWT is a D port of Java's SWT. It is as thus nearly identical and you can use Java's documentation with very little effort - copy/paste of Java examples almost just work as D too. But, the eclipse docs are meh and besides, it is nice to have the D docs anyway. Thankfully, there's plenty of documentation comments in the dwt source. Alas, they are javadoc comments. Well, now adrdox knows how to read javadoc (if specifically told to). I don't have a great entry point to the docs, so it will just go to the Display class... but take a look: http://dwt.dpldocs.info/index.html As you click around, you can navigate, see the inheritance trees, and might even notice some of the java.lang namespace in there! http://dwt.dpldocs.info/java.lang.String.html Well, I made a mistake generating these and there's a broken image and link in the header... but the text body looks pretty good! Any DWT users who can give me feedback on the quality? This is pretty cool :) A few comments and comparing with the Javadocs there are a few things missing: * It doesn't seem to be possible to navigate between the top level packages, i.e. "java" and "org" * No inheritance chain * No implemented interfaces * 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 -- /Jacob Carlborg
Re: DWT API Documentation now on dpldocs.info
On Thursday, 8 March 2018 at 01:21:44 UTC, Adam D. Ruppe wrote: I don't have a great entry point to the docs, so it will just go to the Display class... but take a look: I would recommend the "swt" package [1] as an entry point. Or we could add some documentation to the "all" or "std" modules [2] [3] and use one of those. [1] http://dwt.dpldocs.info/org.eclipse.swt.html [2] https://github.com/d-widget-toolkit/dwt/blob/master/org.eclipse.swt.gtk.linux.x86/src/org/eclipse/swt/all.d [3] https://github.com/d-widget-toolkit/dwt/blob/master/org.eclipse.swt.gtk.linux.x86/src/org/eclipse/swt/std.d -- /Jacob Carlborg
Re: DWT API Documentation now on dpldocs.info
On Thursday, 8 March 2018 at 01:21:44 UTC, Adam D. Ruppe wrote: As some of you might know, DWT is a D port of Java's SWT. It is as thus nearly identical and you can use Java's documentation with very little effort - copy/paste of Java examples almost just work as D too. [...] Thank you, Adam. You made my day!
Re: DWT API Documentation now on dpldocs.info
On Thursday, 8 March 2018 at 01:34:12 UTC, Bill Baxter wrote: The logo in the corner - http://dwt.dpldocs.info/d-logo.png is a 404 btw. Yeah, I realized after generating the files that I used the wrong header source. The search is a broken link too... All fixed now via some hacky redirects :)
Re: DWT API Documentation now on dpldocs.info
The logo in the corner - http://dwt.dpldocs.info/d-logo.png -- is a 404 btw. On Wed, Mar 7, 2018 at 5:32 PM, Bill Baxter wrote: > Cool! I used to love using DWT back in the day. > > Yeh the Eclipse ones look like they were written by someone trying very > hard to make you think you were using a native app on some platform with a > horrible UI from the 90s. > > --bb > > On Wed, Mar 7, 2018 at 5:28 PM, Adam D. Ruppe via Digitalmars-d-announce < > digitalmars-d-announce@puremagic.com> wrote: > >> Compare and contrast with the official Java dox: >> >> http://help.eclipse.org/luna/index.jsp?topic=/org.eclipse.pl >> atform.doc.isv/reference/api/org/eclipse/swt/package-summary.html >> >> both are generated from basically the same doc comments, but I like mine >> better :) >> > >
Re: DWT API Documentation now on dpldocs.info
Cool! I used to love using DWT back in the day. Yeh the Eclipse ones look like they were written by someone trying very hard to make you think you were using a native app on some platform with a horrible UI from the 90s. --bb On Wed, Mar 7, 2018 at 5:28 PM, Adam D. Ruppe via Digitalmars-d-announce < digitalmars-d-announce@puremagic.com> wrote: > Compare and contrast with the official Java dox: > > http://help.eclipse.org/luna/index.jsp?topic=/org.eclipse.pl > atform.doc.isv/reference/api/org/eclipse/swt/package-summary.html > > both are generated from basically the same doc comments, but I like mine > better :) >
Re: DWT API Documentation now on dpldocs.info
Compare and contrast with the official Java dox: http://help.eclipse.org/luna/index.jsp?topic=/org.eclipse.platform.doc.isv/reference/api/org/eclipse/swt/package-summary.html both are generated from basically the same doc comments, but I like mine better :)
DWT API Documentation now on dpldocs.info
As some of you might know, DWT is a D port of Java's SWT. It is as thus nearly identical and you can use Java's documentation with very little effort - copy/paste of Java examples almost just work as D too. But, the eclipse docs are meh and besides, it is nice to have the D docs anyway. Thankfully, there's plenty of documentation comments in the dwt source. Alas, they are javadoc comments. Well, now adrdox knows how to read javadoc (if specifically told to). I don't have a great entry point to the docs, so it will just go to the Display class... but take a look: http://dwt.dpldocs.info/index.html As you click around, you can navigate, see the inheritance trees, and might even notice some of the java.lang namespace in there! http://dwt.dpldocs.info/java.lang.String.html Well, I made a mistake generating these and there's a broken image and link in the header... but the text body looks pretty good! Any DWT users who can give me feedback on the quality?