Re: Added support for doxygen

[Philip Van Hoof <spam pvanhoof be>]

On Tue, 2006-08-29 at 17:38 +0200, Philip Van Hoof wrote:
> I added some support for doxygen API documentation generation in
> docs/devel/doxygen

I would like to ask people who are interested in fine documentation to
check the iface.c source files in libtinymail and libtinymailui. They
contain most of the API documentation.

I have been adding lots of extra notes and comments and .. API
documentation. More than I can imagine somebody would ever need.

This, however, means spelling errors and wording errors (I'm not native
English so I don't always know the best way to put something into
words).

It also means that whatever I documented, should also be tested and
should come with a actual unit test. If you don't find the unit test for
some functionality that I described, then that is a bug that we must fix
a.s.a.p. (and the non-availability of a unit test is considered to be an
extremely serious bug, a release blocked indeed: the release WILL have
unit tests for all testable functionality exposed by the framework, else
there WILL NOT be a release).

I'm already extremely busy with all the work involved with tinymail at
this moment. It might be humanly possible to work even faster but I'm
not sure whether or not that would still be healthy for me. Maybe I
shouldn't whine but .. a fact is that I also have a daytime job and a
cute girlfriend. They earn my respect and time too. Simple and honest.

Therefore I'm forced to ask other people to do this, if people want a
release faster than a month (and I will NOT be pragmatic about
documentation, unit testing, a stable API and stable reference
counting).

So please please please .. if you really want to help tinymail but don't
feel like jumping in a rather large mountain of code: start with unit
tests, documentation, monitoring reference counting and memory and
trying out the API and giving me feedback about it.

About what I said about unit tests: I'm serious, yes.

-- 
Philip Van Hoof, software developer at x-tend 
home: me at pvanhoof dot be 
gnome: pvanhoof at gnome dot org 
work: vanhoof at x-tend dot be 
http://www.pvanhoof.be - http://www.x-tend.be