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: Doug Evans <dje at google dot com>
- To: Stan Shebs <stanshebs at earthlink dot net>
- Cc: gdb-patches <gdb-patches at sourceware dot org>
- Date: Fri, 7 Feb 2014 21:27:15 -0800
- Subject: Re: [PATCH] Use Doxygen for internals documentation
- Authentication-results: sourceware.org; auth=none
- References: <52F420E0 dot 9050203 at earthlink dot net>
On Thu, Feb 6, 2014 at 3:55 PM, Stan Shebs <stanshebs@earthlink.net> wrote:
> Here is the official patch for the introduction of Doxygen that I
> proposed last fall.
>
> This differs from the RFC version in including a filter as
> suggested by Pedro, and having an index page that points to the
> different sets of pages.
>
> Among other things, the filter gives us the option of flagging
> Doxygen comments with "/* * ", which is lower-impact than the
> previous requirement of putting "/**" on a line by itself - in
> other words, just adding a " *" to existing comments.
>
> As before, "cd doc; make doxy" in an objdir creates, then browse
> doc/doxy/index.html to connect to everything.
>
> In the absence of any fatal flaws, I expect to commit this next
> week, and then follow up with patches that doxygenate some
> representative header files. At some point we'll also want to
> add a snapshot-generated set of pages to the website.
Awesome!