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
---------------------------(end of broadcast)---------------------------
TIP 5: don't forget to increase your free space map settings
