Thread: Re: [HACKERS] source documentation tool doxygen
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 "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 few people found it useful but it somehow got stuck. The reason was
> apparently that you'd have to tweak your comments in order to profit from
> it as much as possible.
>
> However I still think it's a nice-to-have among the online documentation
> and it gives people quite new to the code the possibility to easily check
> what is where defined and how... What do you think?
>
> doxygen can also produce a pdf but I haven't succeeded in doing that so far,
> pdflatex keeps bailing out. Has anybody else succeeded building this yet?
>
>
>
> Joachim
>
> --
> Joachim Wieland joe@mcknight.de
> C/ Usandizaga 12 1?B ICQ: 37225940
> 20002 Donostia / San Sebastian (Spain) GPG key available
>
> ---------------------------(end of broadcast)---------------------------
> TIP 3: Have you checked our extensive FAQ?
>
> http://www.postgresql.org/docs/faq
>
--
Bruce Momjian | http://candle.pha.pa.us
pgman@candle.pha.pa.us | (610) 359-1001
+ If your life is a hard drive, | 13 Roberts Road
+ Christ can be your backup. | Newtown Square, Pennsylvania 19073
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 to it from the > PostgreSQL developers page? > > http://www.postgresql.org/developer/coding > > --------------------------------------------------------------------------- > > Joachim Wieland wrote: >> 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 few people found it useful but it somehow got stuck. The reason was >> apparently that you'd have to tweak your comments in order to profit from >> it as much as possible. >> >> However I still think it's a nice-to-have among the online documentation >> and it gives people quite new to the code the possibility to easily check >> what is where defined and how... What do you think? >> >> doxygen can also produce a pdf but I haven't succeeded in doing that so far, >> pdflatex keeps bailing out. Has anybody else succeeded building this yet? >> >> >> >> Joachim >> >> -- >> Joachim Wieland joe@mcknight.de >> C/ Usandizaga 12 1?B ICQ: 37225940 >> 20002 Donostia / San Sebastian (Spain) GPG key available >> >> ---------------------------(end of broadcast)--------------------------- >> TIP 3: Have you checked our extensive FAQ? >> >> http://www.postgresql.org/docs/faq >> > > -- > Bruce Momjian | http://candle.pha.pa.us > pgman@candle.pha.pa.us | (610) 359-1001 > + If your life is a hard drive, | 13 Roberts Road > + Christ can be your backup. | Newtown Square, Pennsylvania 19073 > > ---------------------------(end of broadcast)--------------------------- > TIP 5: don't forget to increase your free space map settings > ---- Marc G. Fournier Hub.Org Networking Services (http://www.hub.org) Email: scrappy@hub.org Yahoo!: yscrappy ICQ: 7615664
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't be worked up to integrate the look with the rest of the site. Michael Glaesemann grzm myrealbox com
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 to it from the > PostgreSQL developers page? > > http://www.postgresql.org/developer/coding > > --------------------------------------------------------------------------- > > Joachim Wieland wrote: > > 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 few people found it useful but it somehow got stuck. The reason > > was apparently that you'd have to tweak your comments in order to profit > > from it as much as possible. > > > > However I still think it's a nice-to-have among the online documentation > > and it gives people quite new to the code the possibility to easily check > > what is where defined and how... What do you think? > > > > doxygen can also produce a pdf but I haven't succeeded in doing that so > > far, pdflatex keeps bailing out. Has anybody else succeeded building this > > yet? > > > > > > > > Joachim > > > > -- > > Joachim Wieland > > joe@mcknight.de C/ Usandizaga 12 1?B > > ICQ: 37225940 20002 Donostia / San Sebastian (Spain) > > GPG key available > > > > ---------------------------(end of broadcast)--------------------------- > > TIP 3: Have you checked our extensive FAQ? > > > > http://www.postgresql.org/docs/faq -- Robert Treat Build A Brighter Lamp :: Linux Apache {middleware} PostgreSQL
Bruce Momjian <pgman@candle.pha.pa.us> 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 contrary? I'd be happier with the
pretty pictures if they had some connection to reality.
regards, tom lane
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 had some connection to reality. True. Doxygen is developped for documenting C++ source code. There is however an option OPTIMIZE_OUTPUT_FOR_C which is set. There are a few more options for class and collaboration graphs as well as a switch to create a graphical class hierarchy, all of them are turned on at the moment. So it might get more concise but we'll have to play around with it to see what is useful and what isn't. Joachim -- Joachim Wieland joe@mcknight.de C/ Usandizaga 12 1°B ICQ: 37225940 20002 Donostia / San Sebastian (Spain) GPG key available
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 ;-) Some details: What I have put online on my website occupies about 240 MBs of disk space and gets built in 1.5h on my PIII 800 Laptop. Removing useless graphs this can be reduced to less than 200 MBs I imagine. 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 course but I figure it would be sufficient to do that once a week... Joachim -- Joachim Wieland joe@mcknight.de C/ Usandizaga 12 1°B ICQ: 37225940 20002 Donostia / San Sebastian (Spain) GPG key available
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 header and footer as well. The postgresql logo on top would be nice but the navigation menu on the left has to be sacrificed for more space. Joachim -- Joachim Wieland joe@mcknight.de C/ Usandizaga 12 1°B ICQ: 37225940 20002 Donostia / San Sebastian (Spain) GPG key available
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 course but I > figure it would be sufficient to do that once a week... > 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 benefit, I think. I don't see any virtue in doing it against a release as opposed to a stable branch - this is to help development efforts so it should be against what people should be basing their development efforts on. cheers andrew
"Andrew Dunstan" <andrew@dunslane.net> 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 benefit, I think.
I agree --- I see no reason for us to maintain such documentation for
anything except HEAD. If somebody really wants documentation for a
stable branch, they can build it themselves.
regards, tom lane