Re: source documentation tool doxygen - Mailing list pgsql-hackers

From Thomas Hallgren
Subject Re: source documentation tool doxygen
Date
Msg-id 43CB85A8.9080001@tada.se
Whole thread Raw
In response to source documentation tool doxygen  (Joachim Wieland <joe@mcknight.de>)
Responses Re: source documentation tool doxygen  (Kim Bisgaard <kib@dmi.dk>)
Re: source documentation tool doxygen  ("Andrew Dunstan" <andrew@dunslane.net>)
List pgsql-hackers
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 "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
> 



pgsql-hackers by date:

Previous
From: Joachim Wieland
Date:
Subject: source documentation tool doxygen
Next
From: Kim Bisgaard
Date:
Subject: Re: source documentation tool doxygen