Re: source documentation tool doxygen

From: Thomas Hallgren <thomas(at)tada(dot)se>
To: pgsql-hackers(at)postgresql(dot)org
Cc: jgardner(at)jonathangardner(dot)net
Subject: Re: source documentation tool doxygen
Date: 2006-01-16 11:38:16
Message-ID: 43CB85A8.9080001@tada.se
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers pgsql-www

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
>

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Kim Bisgaard 2006-01-16 12:44:50 Re: source documentation tool doxygen
Previous Message Joachim Wieland 2006-01-16 08:49:36 source documentation tool doxygen

Browse pgsql-www by date

  From Date Subject
Next Message Kim Bisgaard 2006-01-16 12:44:50 Re: source documentation tool doxygen
Previous Message Dave Page 2006-01-16 11:23:07 Re: pgsql-committers shouldn't be the default "developers" list