www.digitalmars.com         C & C++   DMDScript  

digitalmars.D.announce - Gtk-D API Documentation now on dpldocs.info

reply Adam D. Ruppe <destructionator gmail.com> writes:
GtkD is a D wrapper to the GTK library. It has plenty of doc 
comments attached... but they are in a special GTK syntax and all 
the cross references refer to C structs and functions instead of 
to D classes and methods.

Well, adrdox got some special-case code to handle this and do the 
translations for us! I'd say I got it about 95% handled 
automatically... and I like the result a lot more than the 
official docs for either D or C.

Take a look!

http://gtk-d.dpldocs.info/index.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!

You can navigate around there and even go to the root and see all 
the various packages included in gtkd:

http://gtk-d.dpldocs.info/gtk.html


Any Gtk-D users here who can give me some practical feedback? 
Unlike most dub packages, gtkd is just too big to automatically 
generate on the server, so I have to do it on my computer and 
copy the (almost 26,000!!!) files up to the 'net. So I won't 
update it frequently, but I will keep improving if I hear good 
ideas.
Mar 07
next sibling parent Adam D. Ruppe <destructionator gmail.com> writes:
Compare and contrast to the official gtk-d docs:

https://api.gtkd.org/gtkd/gtk/AboutDialog.html

and the C gtk docs:

https://developer.gnome.org/gtk3/stable/GtkApplication.html


You can see they are all generated from the same source doc 
comments, but I think mine is nicest - just translating the links 
into the D names helps. Even if you can do it in your head once 
you get to know the pattern, having clicks just work to get you 
there are nice.
Mar 07
prev sibling next sibling parent ANtlord <antlord92 gmail.com> writes:
On Thursday, 8 March 2018 at 01:27:07 UTC, Adam D. Ruppe wrote:
 GtkD is a D wrapper to the GTK library. It has plenty of doc 
 comments attached... but they are in a special GTK syntax and 
 all the cross references refer to C structs and functions 
 instead of to D classes and methods.

 Well, adrdox got some special-case code to handle this and do 
 the translations for us! I'd say I got it about 95% handled 
 automatically... and I like the result a lot more than the 
 official docs for either D or C.

 Take a look!

 http://gtk-d.dpldocs.info/index.html
Great job! Thanks a lot!
Mar 07
prev sibling parent reply Mike Wey <mike-wey example.com> writes:
On 08-03-18 02:27, Adam D. Ruppe wrote:
 GtkD is a D wrapper to the GTK library. It has plenty of doc comments 
 attached... but they are in a special GTK syntax and all the cross 
 references refer to C structs and functions instead of to D classes and 
 methods.
 
 Well, adrdox got some special-case code to handle this and do the 
 translations for us! I'd say I got it about 95% handled automatically... 
 and I like the result a lot more than the official docs for either D or C.
 
 Take a look!
 
 http://gtk-d.dpldocs.info/index.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!
 
 You can navigate around there and even go to the root and see all the 
 various packages included in gtkd:
 
 http://gtk-d.dpldocs.info/gtk.html
 
 
 Any Gtk-D users here who can give me some practical feedback? Unlike 
 most dub packages, gtkd is just too big to automatically generate on the 
 server, so I have to do it on my computer and copy the (almost 
 26,000!!!) files up to the 'net. So I won't update it frequently, but I 
 will keep improving if I hear good ideas.
It looks great. Only glib (http://gtk-d.dpldocs.info/glib.html) seems to be broken / missing. -- Mike Wey
Mar 08
parent Adam D. Ruppe <destructionator gmail.com> writes:
On Thursday, 8 March 2018 at 18:11:47 UTC, Mike Wey wrote:
 Only glib (http://gtk-d.dpldocs.info/glib.html) seems to be 
 broken / missing.
Yeah, the index broke for some reason. But the files are there: http://gtk-d.dpldocs.info/glib.ArrayG.ArrayG.html and once you get inside you can navigate from the sidebar.
Mar 08