public inbox for [email protected]
help / color / mirror / Atom feedFrom: Kim Bisgaard <[email protected]>
To: [email protected]
Subject: Re: source documentation tool doxygen
Date: Mon, 16 Jan 2006 13:44:50 +0100
Message-ID: <[email protected]> (raw)
In-Reply-To: <[email protected]>
References: <[email protected]>
<[email protected]>
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
>
view thread (20+ messages) latest in thread
reply
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: [email protected]
Cc: [email protected], [email protected]
Subject: Re: source documentation tool doxygen
In-Reply-To: <[email protected]>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox