DOCUMENTATION (yes, this is shouted)

["Juergen A. Erhard" <jae laden ilk de>]

-----BEGIN PGP SIGNED MESSAGE-----

Just been looking into GTK 1.1.1 (maybe 1.1.2 is out... had this one
lying about for a couple days).

Now, am I the only programmer who sometimes puts some comments in his
code?  The gtkprogress.c, for example, sports exactly 5(!) comments.
And this is counting the copyright header and one comment that
consists of a row of '*'.

How should *anyone* understand what's going on?  I can't...

Wouldn't it be nice if we could at least say what a function
*does*... and comment some of the more dynamic things (signals passed
and such)... and maybe add it to gtk.texi (gtkprogress is *not* in
there)... maybe even document it there.

Face it: the documentation situation is *the* major problem GTK
has... (especially compared to QT).  No, the tutorial doesn't cut
it... *reference docs* are what an experienced developer needs in the
long run.  I can't go through the tutorial every time I need the
semantics of a certain function...

I really thought this was gonna improve...

Bye, J

PS: "And what do *you* do for it?"  Well, I'd love to... but I really
don't think my knowledge of GTK is intimate enough to do this in a
realiable way (and when someone more experienced has to got over my
stuff in the end, correcting many mistakes, he could just as well
write it himself).

- -- 
Jürgen A. Erhard  eMail: jae@laden.ilk.de  phone: (GERMANY) 0721 27326
   MARS: http://members.tripod.com/~Juergen_Erhard/mars_index.html
	      GTK - Free X Toolkit (http://www.gtk.org)
	Win32 has many known work arounds. For example, Linux.

-----BEGIN PGP SIGNATURE-----
Version: 2.6.3ia
Charset: noconv
Comment: Processed by Mailcrypt 3.4, an Emacs/PGP interface

iQEVAwUBNdEN0gIG66LugGzRAQFyzwf/RvOTswAzlrUbD41O3uTszFidSlC6S42J
J086+49iGp8OrgDpf4p6cfqZrnv6CvGJwlI9/7uvSZv9HFxrckjO9HpqC9cSklot
239aA3bCirP4JzpyVywSyIi3pc5r/N8EXfVdkZR4Is5vvcVNr614XVtTX/cUXNgB
rhgAvtPwRomYPj4EobkhVRt234OfocRIMiscpb5HErRqhC+qu1VsDrlENnVPeDLc
7gvX3UO/+stzfRU5WOiquUDTlgeSQ0Gjur7n43/wKtMCX70phVGFV5RxXsF7WtQQ
TV1jRokSKYIWIgpC0nxFtEh9jnkS+GEXO777uMAky8lmZdWot240OQ==aAwt
-----END PGP SIGNATURE-----