This is the mail archive of the
gcc@gcc.gnu.org
mailing list for the GCC project.
Re: "Documentation by paper"
- From: Diego Novillo <dnovillo at redhat dot com>
- To: Richard Kenner <kenner at vlsi1 dot ultra dot nyu dot edu>
- Cc: "gcc at gcc dot gnu dot org" <gcc at gcc dot gnu dot org>
- Date: Tue, 27 Jan 2004 13:23:01 -0500
- Subject: Re: "Documentation by paper"
- Organization: Red Hat Canada
- References: <10401271809.AA29608@vlsi1.ultra.nyu.edu>
On Tue, 2004-01-27 at 13:09, Richard Kenner wrote:
> Which reminds me. What happened to the proposal that was discussed in
> the last GCC summit to start adding doxygen markers to the source code
> comments?
>
> I'd be very strongly *against* such a proposal. I don't see anything but
> the slightest advantage of such "external" documentation, certainly not
> worth cluttering up code with "markers".
>
*shrug* No strong opinions here. Formatting markers don't bother me.
> If there is a value to having such external documentation, let's teach it
> how to read GCC's documentation style, which already has enough information.
>
Which is what we do with the script to publish tree-ssa source
documentation.
Diego.