Re: "Documentation by paper"

[Ian Lance Taylor <ian at wasabisystems dot com>]

Phil Edwards <phil@codesourcery.com> writes:

> I certainly never called it that.  I certainly don't dispute the need for
> writing down what you're asking for.  But we also need useful API catalogs:
> 
>      http://www.jaj.com/space/phil/gccdoxy/struct___unwind___context.html
> 
> and cross-references:
> 
>      http://www.jaj.com/space/phil/gccdoxy/unwind-dw2-fde-glibc_8c__incl.png
> 
> and trying to do those by hand is just monstrously stupid.

Well, those aren't really my cup of tea, but, if you like them, it
seems entirely possible to generate them from the source code
directly.  At least, Source Navigator manages it.  If you want to also
pick up the comment immediately preceding the function, that too seems
possible.

Do source code annotations help produce the sorts of thing you show in
these examples?

Ian