This is the mail archive of the
gcc@gcc.gnu.org
mailing list for the GCC project.
Re: "Documentation by paper"
- From: Joe Buck <Joe dot Buck at synopsys dot COM>
- To: Richard Kenner <kenner at vlsi1 dot ultra dot nyu dot edu>
- Cc: lars dot segerlund at comsys dot se, gcc at gcc dot gnu dot org
- Date: Tue, 27 Jan 2004 09:50:10 -0800
- Subject: Re: "Documentation by paper"
- References: <10401271550.AA28749@vlsi1.ultra.nyu.edu>
> Perhaps the documentation doesn't have to be in the file, but there
> has to be some texinfo documentation for it ?
On Tue, Jan 27, 2004 at 10:50:28AM -0500, Richard Kenner wrote:
> No, I think it has to be in the file. That's the most logical place for it
> and the only place that has any hope of being maintained as the file changes.
Paper documentation is nice as well, but the way to get both, and to keep
the code and documentation consistent, is to use doxygen-style comments
and use that to generate the documentation.