Docs fail to compile succesfully (Doxygen/DDoc)

I have found doxygen 'works' if you build docs for each subfolder separately. However this makes the output a little more messy, and there are a lot of blank linked packages..

Interesting. I guess something's wrong with the way doxygen handles imports, probably a circular inclusion. I intend to have something working by the weekend, thanks for your report.

DDoc formatter. Parses all comments and converts them to DDoc style formatting.

*Sigh* It seems the above script is not enough. Something is preventing DDoc's parser from going through certain source files. A simple side by side visual comparison does not reveal any potentially relevant differences. I guess we'll have to keep looking...

src/gtk/Selections.d gets fully documented by DDoc. src/gtk/Notebook.d gets a blank page. Why?

I would personally prefer it if Doxygen was used instead of DDoc. It outputs cleaner looking documents, and it seems to be much easier to browse through.

However with that said, I can't see why DDoc won't work..

Replying to Pse:

src/gtk/Selections.d gets fully documented by DDoc. src/gtk/Notebook.d gets a blank page. Why?

The Biggest problem with the DDoc in GtkD seems to be that the DDoc comments for the classes are above the 'import gtk.parent;' instead of above the actual class.

Example:

/**
 * Comments
 */
import gtk.ParentClass;
public class Class : ParentClass

Has no DDoc generated while the following does have DDoc generated.

import gtk.ParentClass;
/**
 * Comments
 */
public class Class : ParentClass

I've changed the warper to get proper DDoc comments, So far the DDoc seems to get generated correctly with these changes.

wraper DDoc patch.

Great job, Mike. I'll test this as soon as possible and get it committed if possible.
I'll see about creating a proper 'AUTHORS' file to get all contributions properly listed.

TiMBuS, I intend to get Doxygen working somewhere along the road. However, for the moment, getting at least one type of documentation shipping with gtkD seems like a much safer bet.

There seems to be a problem wrapping certain files with your patch, Mike. For instance, in glade/Glade.d only some comments get converted to DDoc format.

This seems to come from the code in the APILookup*.txt files, witch has all kinds of different documentation, (DDoc, Doxygen, copy/paste of Documentation).

I'll attach the diff's of a few updated APILookup*.txt files.

DDoc in APILookupcairo.txt, includes the cairoLib.Cairo -> cairo.Cotext change

DDoc in APILookupGtk.txt + added empty comments to functions that had none

DDoc in APILookupGlade.txt

DDoc in APILookup[Atk | Gda | Gdk | GdkPixbuf? | Gld | Gilb].txt

Mike, would you mind revising your ddoc-cairo.diff patch? It seems it has introduced a bug:

cairo/Context.d:158: constructor cairo.Context.Context.this (cairo_t *) does not match parameter types (cairo_t *)
cairo/Context.d:158: Error: cyclic constructor call
cairo/Context.d:158: Error: cannot implicitly convert expression ((*gdk_cairo_create)((drawable.getDrawableStruct)())) of type cairo_t * to gdk.Drawable.Drawable
cairo/Context.d:170: Error: cannot implicitly convert expression ((this.getContextStruct)()) of type cairo_t * to cairo_t *
cairo/Context.d:186: Error: cannot implicitly convert expression ((this.getContextStruct)()) of type cairo_t * to cairo_t *
cairo/Context.d:202: Error: cannot implicitly convert expression ((this.getContextStruct)()) of type cairo_t * to cairo_t *
cairo/Context.d:214: Error: cannot implicitly convert expression ((this.getContextStruct)()) of type cairo_t * to cairo_t *
cairo/Context.d:226: Error: cannot implicitly convert expression ((this.getContextStruct)()) of type cairo_t * to cairo_t *

The diffs are in r331 already. Once we can sort this out, I'll rewrap gtkD to reflect these changes.

Amusing: I've switched to DMD and I'm getting completely different errors while compiling. Looking at the gdc output above, it should be obvious something is really wrong with it. Just how broken can a compiler be? This is DMD's output:

gtkc/gdk.d(31): module cairoLibtypes cannot read file 'gtkc/cairoLibtypes.d'

Now that looks reasonable.

On the upside of things, DDoc seems to be working.

Replying to Pse:

Amusing: I've switched to DMD and I'm getting completely different errors while compiling. Looking at the gdc output above, it should be obvious something is really wrong with it. Just how broken can a compiler be? This is DMD's output: {{{ gtkc/gdk.d(31): module cairoLibtypes cannot read file 'gtkc/cairoLibtypes.d' }}} Now that looks reasonable. On the upside of things, DDoc seems to be working.

Fixed in r332. Ignore comment 14, it seems gtkD has actually managed to hit 4 potentially unrelated gdc bugs. Nice.

Preparing for full rewrap.

The rest of the APILookup*.txt files

Replying to Pse:

Fixed in r332. Ignore comment 14, it seems gtkD has actually managed to hit 4 potentially unrelated gdc bugs. Nice.

That gdc is unable to convert cairo_* to cairo_* looks like a very strange error. :P

I see in r332 that i missed one import.

Rewrapped gtkD in r336. Just call:

./makedocs.sh

And you'll get candydoc style docs in the docs folder. Thanks a lot, Mike.

BTW, I've not added your ddoc-theRest.diff patch yet. I'll commit it and leave it ready for the next rewrap.

ddoc-theRest.diff in r337.

DDoc should suffice for now. I'll open a separate ticket for Doxygen support and set it to release 1.0.