Re: [Qemu-devel] [PATCH v2 0/4] GTK-DOC build integration (v2)

[Lluís Vilanova]

Anthony Liguori writes:
[...]
> For v2, I'm relying on a fork of gtk-doc that removes the underscore
> requirements.  I really hate to do this but I like it better than not having
> documentation.  I'm poking in the gtk+ community to see if there's an upstream
> compromise possible.

I don't want to start any kind of flame, but did you consider the possibility of
using doxygen instead?

>From my experience, it's pretty complete and also contains all kinds of
predefined keywords for documenting pre/post-conditions, notes, warnings, etc.

Besides, it offers the possibility to document "things" separately from the code
(e.g., auto-generated structures, or elements declared differently depending on
defines), which I was unable to do with some quick tests I had with gtkdoc.


Lluis

-- 
 "And it's much the same thing with knowledge, for whenever you learn
 something new, the whole world becomes that much richer."
 -- The Princess of Pure Reason, as told by Norton Juster in The Phantom
 Tollbooth