This is the mail archive of the
gcc@gcc.gnu.org
mailing list for the GCC project.
Re: "Documentation by paper"
- From: kenner at vlsi1 dot ultra dot nyu dot edu (Richard Kenner)
- To: dberlin at dberlin dot org
- Cc: gcc at gcc dot gnu dot org
- Date: Tue, 27 Jan 04 13:07:04 EST
- Subject: Re: "Documentation by paper"
I really liked it when tree-ssa had doxygen generated comments.
They have a nice style and form to them that remind you to make sure
you've added docs for all the relevant things in a function (like
return value, etc).
I just looked at what appears to be a manual for doxygen and I must say that
I very much *do not* like those annotations. I think the very slight advantage
of having a separate document does not justify the clutter they cause in the
source files.