From: Joel Brobecker <brobecker@adacore.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: Pedro Alves <pedro@codesourcery.com>, gdb-patches@sourceware.org
Subject: Re: [commit] cleanup stale exec.{h|c} xfer_memory comments.
Date: Sat, 13 Jun 2009 11:12:00 -0000 [thread overview]
Message-ID: <20090613111210.GN25703@adacore.com> (raw)
In-Reply-To: <E1MFKCv-000806-VP@fencepost.gnu.org>
> Is the convention to describe functions in headers? That's reasonable
> for data structures, but we have a lot of functions documented right
> before their source, not in the headers. I find the documentation in
> the .c files easier to use, because you don't need to consult another
> file. This is C, not C++, so the interface and the implementation are
> not separated.
Unfortunately, I don't think we really have a hard convention in GDB.
For C, I also tend to prefer documenting the function next to the
implementation. It's the only way to be consistent, since some functions
do not have advance declarations.
--
Joel
next prev parent reply other threads:[~2009-06-13 11:12 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2009-06-12 18:41 Pedro Alves
2009-06-13 3:47 ` Eli Zaretskii
2009-06-13 11:12 ` Joel Brobecker [this message]
2009-06-15 18:31 ` Tom Tromey
2009-06-16 0:20 ` Joel Brobecker
2009-06-23 19:59 ` Stan Shebs
2009-06-23 20:54 ` Tom Tromey
2009-06-13 11:48 ` Pedro Alves
2009-06-13 12:24 ` Eli Zaretskii
2009-06-13 13:26 ` Pedro Alves
2009-06-13 13:31 ` Eli Zaretskii
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=20090613111210.GN25703@adacore.com \
--to=brobecker@adacore.com \
--cc=eliz@gnu.org \
--cc=gdb-patches@sourceware.org \
--cc=pedro@codesourcery.com \
/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