source documentation tool doxygen - Mailing list pgsql-hackers

From Joachim Wieland
Subject source documentation tool doxygen
Date
Msg-id 20060116084936.GA7072@mcknight.de
Whole thread Raw
Responses Re: source documentation tool doxygen
Re: source documentation tool doxygen
List pgsql-hackers
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


pgsql-hackers by date:

Previous
From: Simon Riggs
Date:
Subject: Re: Coding standards? Recommendations?
Next
From: Thomas Hallgren
Date:
Subject: Re: source documentation tool doxygen