This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: [PATCH] Use Doxygen for internals documentation
- From: Mark Kettenis <mark dot kettenis at xs4all dot nl>
- To: stanshebs at earthlink dot net
- Cc: gdb-patches at sourceware dot org
- Date: Tue, 11 Feb 2014 20:19:42 +0100 (CET)
- Subject: Re: [PATCH] Use Doxygen for internals documentation
- Authentication-results: sourceware.org; auth=none
- References: <52F420E0 dot 9050203 at earthlink dot net> <52FA7509 dot 4010400 at earthlink dot net>
> Date: Tue, 11 Feb 2014 11:07:53 -0800
> From: Stan Shebs <stanshebs@earthlink.net>
>
> On 2/6/14 3:55 PM, Stan Shebs wrote:
> > Here is the official patch for the introduction of Doxygen that I
> > proposed last fall.
>
> This is now pushed.
>
> I've added http://sourceware.org/gdb/wiki/DoxygenForGDB as the
> initial info on what to do with it.
>
> I've also got defs.h, minsyms.h, and utils.[hc] in various states
> of doxygenation, but won't spend a whole lot more time on them
> before pushing them.
>
> For other popular header files, I suggest that if people
> want to jump on any, that we use the wiki page as a simple
> reservation system - although basic doxygenation of a file
> need take only a few minutes, one invariably sees many ways
> to fix up the comment blocks.
When did we agree that using doxygen was a good idea?
I don't want to spend my time on uglifying the source code with stuff
that will never result in usable documentation.
I don't want to be distracted by markup when I'm reading source code
or comments.
Most of all, I don't want to spend any time on arguing about these
stupid things.