Message-ID: <43CB9542.5080707@dmi.dk>
Date: Mon, 16 Jan 2006 13:44:50 +0100
From: Kim Bisgaard <kib@dmi.dk>
User-Agent: Mozilla Thunderbird 1.0.7 (X11/20051013)
MIME-Version: 1.0
To: pgsql-hackers@postgresql.org
Subject: Re: source documentation tool doxygen
References: <20060116084936.GA7072@mcknight.de> <43CB85A8.9080001@tada.se>
In-Reply-To: <43CB85A8.9080001@tada.se>
Content-Type: text/plain; charset=ISO-8859-15; format=flowed
Content-Transfer-Encoding: 7bit

Try following the link (the Doxygen icon) - it has both a tutorial and
extensive doc.

Regards,
Kim Bisgaard

Thomas Hallgren wrote:

> 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
>>
>
>
> ---------------------------(end of broadcast)---------------------------
> TIP 2: Don't 'kill -9' the postmaster
>