public inbox for [email protected]  

help / color / mirror / Atom feed

From: Thomas Hallgren <[email protected]>
To: Andrew Dunstan <[email protected]>
Cc: [email protected]
Cc: [email protected]
Subject: Re: source documentation tool doxygen
Date: Mon, 16 Jan 2006 19:21:52 +0100
Message-ID: <[email protected]> (raw)
In-Reply-To: <[email protected]>
References: <[email protected]>
	<[email protected]>

Andrew,
Why not publish it as it stands today? Changing comments can be done in due time, no need to 
rush it. Or are the comments in some special format today that is used by some other tool?

What I'm trying to say is that for people like me, this would be very useful. Just clicking 
on a structure and see what file it's defined in is great. I don't care much if the comments 
are not perfect from day one (or ever for that matter). I can click on the file and read the 
comments right there if I want to.

If the comments have no special format today, well then perhaps the Doxygen format could be 
a good format to gradually adopt? No need to add checking etc. at this point. Perhaps later 
on (years from now) when most of the comments use that format.

Regards,
Thomas Hallgren

Andrew Dunstan wrote:
> Thomas Hallgren said:
>> 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?
>>
> 
> I too have done this. But retrofitting Doxygen style comments to the
> PostgreSQL source code would be a big undertaking. Maintaining it, which
> would be another task for reviewers/committers, would also be a pain unless
> there were some automated checking tool.
> 
> cheers
> 
> andrew
> 
> 
> 
> ---------------------------(end of broadcast)---------------------------
> TIP 3: Have you checked our extensive FAQ?
> 
>                http://www.postgresql.org/docs/faq
> 

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], [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