[Psi-devel] xmpp compliant clients

Remko Troncon remko at psi-im.org
Wed Nov 9 06:17:50 PST 2005


> http://www.cs.kuleuven.be/~remko/psi/html/annotated.html shows the best
> how much of the code is *really* documented.

Not ... really. It shows how many classes have a '\brief' statement. 
I have documented a few classes, yet forgot to add a \brief, so it's not
as bad as it looks (although very close). Anyway, this is why these days
we demand new functions to be doxygen documented, so everything will
work itself out over time. And of course, we are always open to contributions,
not only source code but documentation as well. Just check with us when
you want to document a part of Psi, then we can tell you how likely it is
that that part will be rewritten soon.

Anyway, we will be generating a public and a more verbose private documentation
bundle on a regular basis (pbb nightly) right after 0.10 is released. 
A preview of the public docs can be seen here:
	http://www.cs.kuleuven.be/~remko/psi/api/public/
with a documented (yet not very central) class:
	http://www.cs.kuleuven.be/~remko/psi/api/public/classGrowlNotifier.html
One of the private one here:
	http://www.cs.kuleuven.be/~remko/psi/api/private/
with the same class:
	http://www.cs.kuleuven.be/~remko/psi/api/private/classGrowlNotifier.html

I'm open for suggestions on both.

cheers,
Remko


More information about the psi-devel mailing list