doxygen & PG
Is this page
http://members.fortunecity.com/nymia/postgres/dox/backend/html/
common knowledge? It appears to be an automatically-generated
cross-reference documentation web site. My impression is that
appropriately-marked comments in the code get extracted to the
web pages, too, so it is also a way to automate internal
documentation.
Nathan Myers
ncm@zembu.com
ncm@zembu.com (Nathan Myers) writes:
Is this page
http://members.fortunecity.com/nymia/postgres/dox/backend/html/
common knowledge?
Interesting, but bizarrely incomplete. (Yeah, we have only ~100
struct types ... sure ...)
regards, tom lane
On Sat, Mar 10, 2001 at 06:29:37PM -0500, Tom Lane wrote:
ncm@zembu.com (Nathan Myers) writes:
Is this page
http://members.fortunecity.com/nymia/postgres/dox/backend/html/
common knowledge?Interesting, but bizarrely incomplete. (Yeah, we have only ~100
struct types ... sure ...)
It does say "version 0.0.1".
What was interesting to me is that the interface seems a lot more
helpful than the current CVS web gateway. If it were to be completed,
and could be kept up to date automatically, something like it could
be very useful.
Nathan Myers
ncm@zembu.com
The site mentioned was created by me. I used doxygen to create those html
files. And it's just the first stab. It doesn't have have doxygen tags yet
that's why it looks like that.
The reason why I made it was to make it easier for me ( and others as well )
to read the code though. So far, I've learned a lot using this technique.
There is another one I'm working on and it's at
http://members.fortunecity.com/nymia/vsta/boot_layout.html
----- Original Message -----
From: Nathan Myers <ncm@zembu.com>
To: <pgsql-hackers@postgresql.org>
Sent: Saturday, March 10, 2001 3:48 PM
Subject: Re: [HACKERS] doxygen & PG
Show quoted text
On Sat, Mar 10, 2001 at 06:29:37PM -0500, Tom Lane wrote:
ncm@zembu.com (Nathan Myers) writes:
Is this page
http://members.fortunecity.com/nymia/postgres/dox/backend/html/
common knowledge?Interesting, but bizarrely incomplete. (Yeah, we have only ~100
struct types ... sure ...)It does say "version 0.0.1".
What was interesting to me is that the interface seems a lot more
helpful than the current CVS web gateway. If it were to be completed,
and could be kept up to date automatically, something like it could
be very useful.Nathan Myers
ncm@zembu.com---------------------------(end of broadcast)---------------------------
TIP 3: if posting/reading through Usenet, please send an appropriate
subscribe-nomail command to majordomo@postgresql.org so that your
message can get through to the mailing list cleanly
doxygen is a great tool to make code documentation...
It is particulary easy for developpers to add /** **/ comments instead of
/* */ comments that will be extracted by doxygen to make documentation on
functions, structures,...
then you run doxygen from cron and you get automatic API documentation. May
be it is a job for the webmaster of the PG web site.
I strongly advise all developers to use it...
Franck Martin
Network and Database Development Officer
SOPAC South Pacific Applied Geoscience Commission
Fiji
E-mail: franck@sopac.org <mailto:franck@sopac.org>
Web site: http://www.sopac.org/
<http://www.sopac.org/> Support FMaps: http://fmaps.sourceforge.net/
<http://fmaps.sourceforge.net/>
This e-mail is intended for its addresses only. Do not forward this e-mail
without approval. The views expressed in this e-mail may not be necessarily
the views of SOPAC.
-----Original Message-----
From: Nymia [mailto:nymia@qwest.net]
Sent: Sunday, 11 March 2001 12:51
To: pgsql-hackers@postgresql.org
Subject: Re: [HACKERS] doxygen & PG
The site mentioned was created by me. I used doxygen to create those html
files. And it's just the first stab. It doesn't have have doxygen tags yet
that's why it looks like that.
The reason why I made it was to make it easier for me ( and others as well )
to read the code though. So far, I've learned a lot using this technique.
There is another one I'm working on and it's at
http://members.fortunecity.com/nymia/vsta/boot_layout.html
----- Original Message -----
From: Nathan Myers <ncm@zembu.com>
To: <pgsql-hackers@postgresql.org>
Sent: Saturday, March 10, 2001 3:48 PM
Subject: Re: [HACKERS] doxygen & PG
On Sat, Mar 10, 2001 at 06:29:37PM -0500, Tom Lane wrote:
ncm@zembu.com (Nathan Myers) writes:
Is this page
http://members.fortunecity.com/nymia/postgres/dox/backend/html/
common knowledge?Interesting, but bizarrely incomplete. (Yeah, we have only ~100
struct types ... sure ...)It does say "version 0.0.1".
What was interesting to me is that the interface seems a lot more
helpful than the current CVS web gateway. If it were to be completed,
and could be kept up to date automatically, something like it could
be very useful.Nathan Myers
ncm@zembu.com---------------------------(end of broadcast)---------------------------
TIP 3: if posting/reading through Usenet, please send an appropriate
subscribe-nomail command to majordomo@postgresql.org so that your
message can get through to the mailing list cleanly
---------------------------(end of broadcast)---------------------------
TIP 3: if posting/reading through Usenet, please send an appropriate
subscribe-nomail command to majordomo@postgresql.org so that your
message can get through to the mailing list cleanly
Import Notes
Resolved by subject fallback