Re: [pgsql-www] [HACKERS] source documentation tool doxygen

2006-01-17 Thread Tom Lane
"Andrew Dunstan" <[EMAIL PROTECTED]> writes: > The overwhelming amount of development work gets done against HEAD. I would > start with a once a day run against HEAD, and possibly one against the > latest stable branch (currently REL8_1_STABLE in cvs). That would get you > 99% of the possible benef

Re: [pgsql-www] [HACKERS] source documentation tool doxygen

2006-01-17 Thread Andrew Dunstan
Joachim Wieland said: > Do you want to put it on the postgresql.org site nevertheless? Is it > too big to be mirrored and should be recreated on every webserver? We > might need one copy for the last version of every major release as well > as one for cvs. The latter should get updated regularly of

Re: [pgsql-www] [HACKERS] source documentation tool doxygen

2006-01-17 Thread Joachim Wieland
On Tue, Jan 17, 2006 at 09:34:06AM +0900, Michael Glaesemann wrote: > Along those lines, I wonder if a CSS couldn't be worked up to > integrate the look with the rest of the site. Yes, it's stylesheet based. However I don't know yet to what extend you can change the look. It allows for a custom he

Re: [pgsql-www] [HACKERS] source documentation tool doxygen

2006-01-17 Thread Joachim Wieland
On Mon, Jan 16, 2006 at 07:42:35PM -0500, Robert Treat wrote: > This was my plan all along, just been waiting for someone to make it work > with the postgresql code and then send instructions to the postgresql web > team on how to set it up. I volunteer to tell you after I've found out for myself

Re: [HACKERS] source documentation tool doxygen

2006-01-17 Thread Joachim Wieland
On Tue, Jan 17, 2006 at 12:15:02AM -0500, Tom Lane wrote: > The thing seems to have only the very vaguest grasp on whether it is > parsing C or C++ ... or should I say that it is convinced it is parsing > C++ despite all evidence to the contrary? I'd be happier with the > pretty pictures if they h

Re: [HACKERS] source documentation tool doxygen

2006-01-16 Thread Tom Lane
Bruce Momjian writes: > Wow, looks great. Is that URL stable? Can we link to it from the > PostgreSQL developers page? The thing seems to have only the very vaguest grasp on whether it is parsing C or C++ ... or should I say that it is convinced it is parsing C++ despite all evidence to the con

Re: [HACKERS] source documentation tool doxygen

2006-01-16 Thread Jonathan Gardner
On Monday 16 January 2006 10:51, Tom Lane wrote: > Neil Conway <[EMAIL PROTECTED]> writes: > > I don't think it would be all that painful. There would be no need to > > convert the entire source tree to use proper Doxygen-style comments in > > one fell swoop: individual files and modules can be con

Re: [pgsql-www] [HACKERS] source documentation tool doxygen

2006-01-16 Thread Robert Treat
This was my plan all along, just been waiting for someone to make it work with the postgresql code and then send instructions to the postgresql web team on how to set it up. Robert Treat On Monday 16 January 2006 18:32, Bruce Momjian wrote: > Wow, looks great. Is that URL stable? Can we link

Re: [pgsql-www] [HACKERS] source documentation tool doxygen

2006-01-16 Thread Michael Glaesemann
On Jan 17, 2006, at 8:40 , Marc G. Fournier wrote: the only question I have ... is there any way of improving that right index? Love the 'detail pages', but somehow making the right index more 'tree like' might make navigation a bit easier ... Along those lines, I wonder if a CSS couldn

Re: [pgsql-www] [HACKERS] source documentation tool doxygen

2006-01-16 Thread Marc G. Fournier
the only question I have ... is there any way of improving that right index? Love the 'detail pages', but somehow making the right index more 'tree like' might make navigation a bit easier ... On Mon, 16 Jan 2006, Bruce Momjian wrote: Wow, looks great. Is that URL stable? Can we link

Re: [HACKERS] source documentation tool doxygen

2006-01-16 Thread Bruce Momjian
Wow, looks great. Is that URL stable? Can we link to it from the PostgreSQL developers page? http://www.postgresql.org/developer/coding --- Joachim Wieland wrote: > I've created a browsable source tree "documentat

Re: [HACKERS] source documentation tool doxygen

2006-01-16 Thread Joachim Wieland
On Tue, Jan 17, 2006 at 06:51:15AM +0900, Michael Glaesemann wrote: > I haven't looked at it yet, but might there not be a way to have a > preprocessing step where the current comment format is converted to > something doxygen-friendly? pg_indent2doxygen or something? Then the > current comment sty

Re: [HACKERS] source documentation tool doxygen

2006-01-16 Thread Michael Glaesemann
On Jan 17, 2006, at 3:51 , Tom Lane wrote: A quick look through the doxygen manual doesn't make it sound too invasive, but I am worried about how well it will coexist with pgindent. It seems both tools think they can dictate the meaning of the characters immediately after /* of a comment b

Re: [HACKERS] source documentation tool doxygen

2006-01-16 Thread Tom Lane
Neil Conway <[EMAIL PROTECTED]> writes: > I don't think it would be all that painful. There would be no need to > convert the entire source tree to use proper Doxygen-style comments in > one fell swoop: individual files and modules can be converted whenever > anyone gets the inclination to do so. I

Re: [HACKERS] source documentation tool doxygen

2006-01-16 Thread Neil Conway
On Mon, 2006-01-16 at 07:57 -0600, Andrew Dunstan wrote: > I too have done this. But retrofitting Doxygen style comments to the > PostgreSQL source code would be a big undertaking. Maintaining it, which > would be another task for reviewers/committers, would also be a pain unless > there were some

Re: [HACKERS] source documentation tool doxygen

2006-01-16 Thread Thomas Hallgren
Andrew, Why not publish it as it stands today? Changing comments can be done in due time, no need to rush it. Or are the comments in some special format today that is used by some other tool? What I'm trying to say is that for people like me, this would be very useful. Just clicking on a struc

Re: [HACKERS] source documentation tool doxygen

2006-01-16 Thread Andrew Dunstan
Thomas Hallgren said: > I wish I've had this when I started working with PostgreSQL. This looks > really good. Very useful indeed, even without the comments. What kind > of changes are needed in order to get the comments in? > I too have done this. But retrofitting Doxygen style comments to the

Re: [HACKERS] source documentation tool doxygen

2006-01-16 Thread Kim Bisgaard
Try following the link (the Doxygen icon) - it has both a tutorial and extensive doc. Regards, Kim Bisgaard Thomas Hallgren wrote: I wish I've had this when I started working with PostgreSQL. This looks really good. Very useful indeed, even without the comments. What kind of changes are neede

Re: [HACKERS] source documentation tool doxygen

2006-01-16 Thread Thomas Hallgren
I wish I've had this when I started working with PostgreSQL. This looks really good. Very useful indeed, even without the comments. What kind of changes are needed in order to get the comments in? Regards, Thomas Hallgren Joachim Wieland wrote: I've created a browsable source tree "documentat

[HACKERS] source documentation tool doxygen

2006-01-16 Thread Joachim Wieland
I've created a browsable source tree "documentation", it's done with the doxygen tool. http://www.mcknight.de/pgsql-doxygen/cvshead/html/ There was a discussion about this some time ago, Jonathan Gardner proposed it here: http://archives.postgresql.org/pgsql-hackers/2004-03/msg00748.php quite a