Re: [HACKERS] source documentation tool doxygen

From: Bruce Momjian <pgman(at)candle(dot)pha(dot)pa(dot)us>
To: Joachim Wieland <joe(at)mcknight(dot)de>
Cc: pgsql-hackers(at)postgresql(dot)org, jgardner(at)jonathangardner(dot)net, PostgreSQL www <pgsql-www(at)postgresql(dot)org>
Subject: Re: [HACKERS] source documentation tool doxygen
Date: 2006-01-16 23:32:07
Message-ID: 200601162332.k0GNW7D28523@candle.pha.pa.us
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers pgsql-www


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(at)mcknight(dot)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(at)candle(dot)pha(dot)pa(dot)us | (610) 359-1001
+ If your life is a hard drive, | 13 Roberts Road
+ Christ can be your backup. | Newtown Square, Pennsylvania 19073

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Marc G. Fournier 2006-01-16 23:40:20 Re: [HACKERS] source documentation tool doxygen
Previous Message Joachim Wieland 2006-01-16 23:04:19 Re: source documentation tool doxygen

Browse pgsql-www by date

  From Date Subject
Next Message Robert Treat 2006-01-16 23:36:37 Re: PgFoundry Move
Previous Message Devrim GUNDUZ 2006-01-16 23:27:46 Re: [Gforge-admins] PgFoundry Move