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: asutton at cs dot kent dot edu
- Cc: gcc at gcc dot gnu dot org
- Date: Tue, 27 Jan 04 13:55:53 EST
- Subject: Re: "Documentation by paper"
not everybody learns from the bottom up. using documentation
generators like doxygen provides a pretty convenient way to provide a
high-level picture of the system and its components. so yes... there
is most definitely value there.
I strongly agree that having high-level documentation is important, but
I don't see that documentation generators produce it!
"high-level documention" means a very broad overview of a program and
how it works. This *cannot* be produced automatically since none of
the information in it would be present anywhere else.
What you are talking about producing isn't anything "high-level", but just
a very low-level directory of functions and data structures.