This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: [RFC] Use Doxygen for internals documentation
- From: Tom Tromey <tromey at redhat dot com>
- To: Stan Shebs <stanshebs at earthlink dot net>
- Cc: gdb-patches at sourceware dot org
- Date: Thu, 17 Oct 2013 14:22:55 -0600
- Subject: Re: [RFC] Use Doxygen for internals documentation
- Authentication-results: sourceware.org; auth=none
- References: <525877F6 dot 40001 at earthlink dot net> <87bo2pw2fj dot fsf at fleche dot redhat dot com> <525EEE76 dot 3080900 at earthlink dot net>
>>>>> "Stan" == Stan Shebs <stanshebs@earthlink.net> writes:
[...]
Stan> Yeah, I think real deployment entails some kind of top-level page that
Stan> is the overall guide.
Thanks for the responses.
I'm on board.
Stan> Another, more incremental approach is to have the API doxyfile list only
Stan> the files that have doxygen-type documentation. So one grows
Stan> the doxyfile as more files get documented, and if foo-tdep.h never
Stan> gets official documentation, it's never clutter in the listing.
This sounds like a good default to me.
Tom