Date: Mon, 16 Jan 2006 09:49:36 +0100
From: Joachim Wieland <joe@mcknight.de>
To: pgsql-hackers@postgresql.org
Cc: jgardner@jonathangardner.net
Subject: source documentation tool doxygen
Message-ID: <20060116084936.GA7072@mcknight.de>
Mime-Version: 1.0
Content-Type: text/plain; charset=iso-8859-15
Content-Disposition: inline
User-Agent: Mutt/1.5.9i
Content-Transfer-Encoding: quoted-printable

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 propose=
d
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 w=
as
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 f=
ar,
pdflatex keeps bailing out. Has anybody else succeeded building this yet?


Joachim

--=20
Joachim Wieland                                              joe@mcknight=
.de
C/ Usandizaga 12 1=B0B                                           ICQ: 372=
25940
20002 Donostia / San Sebastian (Spain)                     GPG key availa=
ble