From: Tom Tromey <tromey@redhat.com>
To: Stan Shebs <stanshebs@earthlink.net>
Cc: gdb-patches@sourceware.org
Subject: Re: [RFC] Use Doxygen for internals documentation
Date: Thu, 17 Oct 2013 20:23:00 -0000 [thread overview]
Message-ID: <87wqlbtzog.fsf@fleche.redhat.com> (raw)
In-Reply-To: <525EEE76.3080900@earthlink.net> (Stan Shebs's message of "Wed, 16 Oct 2013 12:52:22 -0700")
>>>>> "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
next prev parent reply other threads:[~2013-10-17 20:23 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-10-11 22:13 Stan Shebs
2013-10-14 13:20 ` Yao Qi
2013-10-15 23:39 ` Stan Shebs
2013-10-16 17:28 ` Tom Tromey
2013-10-16 19:52 ` Stan Shebs
2013-10-17 20:23 ` Tom Tromey [this message]
2013-11-01 11:18 ` Pedro Alves
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87wqlbtzog.fsf@fleche.redhat.com \
--to=tromey@redhat.com \
--cc=gdb-patches@sourceware.org \
--cc=stanshebs@earthlink.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox