A sheep is not a creature of the air. It has enormous difficulty in the comparatively simple act of perching. (MPFC 2)
Yagdoc is [going to be] a C source code documentation tool with specific support for GObject and Gtk+ based classes and widgets. Something like gtk-doc, only better. Or weirder. In any case, different. Althought not that different as the docstring format is compatible (backward or how you call that direction).
Yagdoc is written in Python (oh crap, doesn't it use indentation or something?) and it strives to keep data – namely various special conventions and package-specific cases – separated from the code, or at least separated. The goal is also to allow users to customize and extend the documentation build process. So that they can implement their crazy ideas themselves instead of bothering me.
At this moment there is nothing to download here yet (everyone stopped reading). You can:
Checkout the source code.
Watch commits at CIA.
Read the FAQ and gtk-doc comparison.
See the SF.net project page.
Component notes: tokenizer, parser, inspect, sectionizer, scanner. And their API documentation.
Inheritance tree of GObject based stuff I have on my hard drive: tree demo.
2007-09-26:
Leaving DocBook sources generation in a somewhat sketchy state, I focused on
infrastrcture and integration to be able to release tarballs. For start it
means a switch from setup.py to GNU autotools.
2007-09-24:
I got rid of all the strange Error classes in every module;
errors are normal exceptions with a GCC-style message formatting capability.
And also made DocBook source name always equal to its id, so we have only two
independent names: header and output, instead of three. This is going to
cause some grief during documentation transitions from gtk-doc though.
2007-09-22: Writing out the DocBook sources is a mess. While I always knew it would be, it is still notable. A long list of particularities and idiosyncracies that just have to be dealt with one by one… I do not expect it to be even more-or-less complete – unlike most other components – by the time of the first release.
As a digression, I wrote a Makefile variable parser to
directly extract settings from the Makefile.
2007-09-09:
I got distracted by some class toying a bit… Anyway, the inspector
organization makes much more sense now: with Type class
representing one GType as the central object.
2007-09-05:
While pieces are still missing in the documentation generation, the project
has produced something usable in practice: yagdoc-comment,
a comment generator. Give it a symbol name and get back an empty comment
template. At this moment it has no special support for objects (and their
signals and properties) and it cannot update existing comments either, but
these will come…
2007-09-02: Implementation notes of scanner were added. The scanner more or less works, so I'm finally getting to generation of DocBook sources.
2007-08-23: Implementation notes of sectionizer were added.