Re: gtkmm API documentation

["Murray Cumming" <murrayc murrayc com>]

> I've been trying to improve the gtkmm documentation lately.  So I've
> been going through the API docs and looking for classes and methods
> that have no documentation.

By the way, this is easier if you look at the doxygen warnings and errors
files generated in docs/reference.

>  Many of these functions and classes do
> have GTK+ documentation, so we could borrow and customize that.  This
> introduces the possibility of getting out of sync with GTK+ if things
> change, but on the other hand, it's a real hassle to have to browse
> over to gtk.org when things are missing in the gtkmm documentation.
> It would be really nice to have all of the documentation for gtkmm
> complete and in one place.
>
> So if no one has any better ideas, I'm going to try to go through and
> borrow as much documentation from the GTK+ docs as possible and add it
> to the gtkmm documentation where it is missing (updated for gtkmm of
> course).

We do much of this automatically, via gtk_docs.xml (generated from
gnome-python/pygtk/codegen/docextract.py) and gtk_docs_override.xml.
However,
1) Some methods are hand-coded. Sometimes you need to write the docs there
by hand, but sometimes you can use _WRAP_METHOD_DOCS_ONLY()
2) Class documentation must be hand-coded.

That still leaves the vast majority as automatically generated, so I think
that's OK.

Here is another email I sent about this:
http://mail.gnome.org/archives/gtkmm-list/2004-January/msg00098.html

Many thanks
Murray Cumming
murrayc murrayc com
www.murrayc.com
www.openismus.com