Re: Doxygen?

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On Wednesday 17 March 2004 5:54 pm, Christopher Kings-Lynne wrote:
> > I was thinking of writing a cron job to update the CVS tree and then
> > build the documentation (takes about 10 minutes on my computer). Then
> > I could push it to wherever you like. Are we currently maintaining
> > two or three branches in the code? We may want to keep them seperate.
> >
> > We could also maintain released postgresql documentation -- IE, one
> > set for PostgreSQL 7.4.0, one set for PostgreSQL 7.4.1, etc... These
> > would only have to be built once.
>
> How about posting a 'doxygen commenting guide' to the list so that we
> know how to comment? Also, maybe it's time we standardised code
> documentation? :)
>

Doxygen manuals are available on the 'net at doxygen.sourceforge.com. I'm
using the '/' style, so no '@' for me. Read through them at your leisure
at http://www.stack.nl/~dimitri/doxygen/manual.html

This page in particular sums up all you need to know:
http://www.stack.nl/~dimitri/doxygen/docblocks.html

As far as a standard, I would like to actually go through and see what
works before we talk of that. Personally, I am /stunned/ by the sheer
volume of comments in the code, and getting all that to show up in
Doxygen is a 6 month project!

- --
Jonathan Gardner
jgardner(at)jonathangardner(dot)net
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.3 (GNU/Linux)

iD8DBQFAWTgpqp6r/MVGlwwRAluNAKCm3zwp5AoY0ChTaJyki/xXRZ+2YACgosV0
RyaDbYFWYIFokmrhjpN4Y+w=
=Srgo
-----END PGP SIGNATURE-----