This is the mail archive of the
gcc@gcc.gnu.org
mailing list for the GCC project.
Re: "Documentation by paper"
On Tuesday 27 January 2004 03:16 pm, Daniel Berlin wrote:
> > | Maybe for you, but i find that incredibly difficult to read and parse
> > | compared to the original marked up version, let alone understand.
> >
> >
> > I far much prefer Richard's version. Simple and clear to read. I've
> > tried to stay far away from the doxygen business in V3land.
> >
>
> To each his own. For me, at least, it requires a few minutes of intense
> staring to try to understand Richard's version, but about 5 seconds to
> understand the first version.
>
> Maybe it's cause law school has screwed up my ability to read.
maybe the @param, @return act as beacons and represent abstractions about the
commented function pretty well. you don't have to read the entire comment to
find the return type or an explanation of one of the parameters.
i'm probably reading it the same way you are. maybe if we built an WYSIWYG
editor that would render doxygen comments on the fly, the whole world could
be happy.
andrew sutton
asutton@cs.kent.edu