Re: source documentation tool doxygen

From: Neil Conway <neilc(at)samurai(dot)com>
To: Andrew Dunstan <andrew(at)dunslane(dot)net>
Cc: thomas(at)tada(dot)se, pgsql-hackers(at)postgresql(dot)org, jgardner(at)jonathangardner(dot)net
Subject: Re: source documentation tool doxygen
Date: 2006-01-16 18:31:40
Message-ID: 1137436300.9145.78.camel@localhost.localdomain
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers pgsql-www

On Mon, 2006-01-16 at 07:57 -0600, Andrew Dunstan wrote:
> 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.

I don't think it would be all that painful. There would be no need to
convert the entire source tree to use proper Doxygen-style comments in
one fell swoop: individual files and modules can be converted whenever
anyone gets the inclination to do so. I don't think the maintenance
burden would be very substantial, either.

-Neil

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Tom Lane 2006-01-16 18:51:38 Re: source documentation tool doxygen
Previous Message Jim C. Nasby 2006-01-16 18:26:43 Re: Improving N-Distinct estimation by ANALYZE

Browse pgsql-www by date

  From Date Subject
Next Message Tom Lane 2006-01-16 18:51:38 Re: source documentation tool doxygen
Previous Message Joshua D. Drake 2006-01-16 18:26:06 PgFoundry Move