From: | Joachim Wieland <joe(at)mcknight(dot)de> |
---|---|
To: | pgsql-hackers(at)postgresql(dot)org |
Cc: | jgardner(at)jonathangardner(dot)net |
Subject: | source documentation tool doxygen |
Date: | 2006-01-16 08:49:36 |
Message-ID: | 20060116084936.GA7072@mcknight.de |
Views: | Raw Message | Whole Thread | Download mbox | Resend email |
Thread: | |
Lists: | pgsql-hackers pgsql-www |
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
From | Date | Subject | |
---|---|---|---|
Next Message | Thomas Hallgren | 2006-01-16 11:38:16 | Re: source documentation tool doxygen |
Previous Message | Simon Riggs | 2006-01-16 08:35:09 | Re: Coding standards? Recommendations? |
From | Date | Subject | |
---|---|---|---|
Next Message | Dave Page | 2006-01-16 11:23:07 | Re: pgsql-committers shouldn't be the default "developers" list |
Previous Message | Dave Page | 2006-01-16 08:26:32 | Re: Infrastructure monitoring |