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: Joe dot Buck at synopsys dot com
- Cc: gcc at gcc dot gnu dot org
- Date: Tue, 27 Jan 04 15:13:46 EST
- Subject: Re: "Documentation by paper"
Fine, doxygen is cool with that. If you write it as
...
it will be treated as a doxygen comment, with the first sentence as
the brief description and the whole paragraph as the long description.
All I changed was the extra * character.
The issue I had was the annotations used to describe the parameters and
return value. I certainly have no problem with the above, except if it's
viewed as replacing proper high-level documentation.