This is the mail archive of the
gcc@gcc.gnu.org
mailing list for the GCC project.
Re: "Documentation by paper"
Phil Edwards <phil@codesourcery.com> writes:
> Kenner, nobody is arguing against having a high-level documentation overview.
> Everybody agrees that it's a great idea. Please, write one. Those of us who
> cannot keep the source code in our heads use these crutches like API listings
> and cross-reference tools. One is not a replacement for the other.
Conversely, nobody is arguing against API listings and cross-reference
tools.
The immediate question is whether to add annotations to comments in
the source code. (Your examples demonstrate that these annotations
are not absolutely required for cross-reference tools.)
The original question was whether to require full descriptions of
algorithms in gcc source files, rather than just references to
academic papers.
Ian