 

> -----Original Message-----
> From: Jonathan Gardner [mailto:jgardner@jonathangardner.net] 
> Sent: 17 March 2004 01:41
> To: pgsql-hackers@postgresql.org
> Subject: [HACKERS] Doxygen?
> 
> I'll start posting the documentation I am generating to my 
> vanity site (announcements later), but would this be 
> something that the postgresql.org main site would be able to 
> host? It'll be a bunch of static HTML files.

This is not something that should be on the main site, but on
developer.postgresql.org. And yes, if there are no objections here then
I see no reason why it cannot be added. I assume you will be able to
keep it up to date?

Regards, Dave. 

Wed, 17 Mar 2004 08:34:04 -0000
"Dave Page" <dpage@vale-housing.co.uk>
Re: Doxygen?
On Wednesday 17 March 2004 12:34 am, Dave Page wrote:
> > -----Original Message-----
> > From: Jonathan Gardner [mailto:jgardner@jonathangardner.net]
> > Sent: 17 March 2004 01:41
> > To: pgsql-hackers@postgresql.org
> > Subject: [HACKERS] Doxygen?
> >
> > I'll start posting the documentation I am generating to my
> > vanity site (announcements later), but would this be
> > something that the postgresql.org main site would be able to
> > host? It'll be a bunch of static HTML files.
>
> This is not something that should be on the main site, but on
> developer.postgresql.org. And yes, if there are no objections here then
> I see no reason why it cannot be added. I assume you will be able to
> keep it up to date?
>

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.

-- 
Jonathan Gardner
jgardner@jonathangardner.net

Wed, 17 Mar 2004 10:45:57 -0800
Jonathan Gardner <jgardner@jonathangardner.net>
Re: Doxygen?
On Wed, 17 Mar 2004, Jonathan Gardner 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.

if you can write the script, and assuming nobody has objections to it, we
can easily run it on the main server, directly into CVS ... doxygen is
already installed for one of our other clients ...


----
Marc G. Fournier           Hub.Org Networking Services (http://www.hub.org)
Email: scrappy@hub.org           Yahoo!: yscrappy              ICQ: 7615664

Wed, 17 Mar 2004 15:56:04 -0400 (AST)
"Marc G. Fournier" <scrappy@postgresql.org>
Re: Doxygen?
> 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? :)

Chris


Thu, 18 Mar 2004 09:54:53 +0800
Christopher Kings-Lynne <chriskl@familyhealth.com.au>
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@jonathangardner.net
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.3 (GNU/Linux)

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

Wed, 17 Mar 2004 21:48:25 -0800
"Jonathan M. Gardner" <jgardner@jonathangardner.net>
Re: Doxygen?