From: Doug Evans <dje@google.com>
To: Pedro Alves <palves@redhat.com>
Cc: gdb-patches <gdb-patches@sourceware.org>
Subject: Re: [RFC] Stop putting function comments in foo.h
Date: Tue, 18 Mar 2014 15:59:00 -0000 [thread overview]
Message-ID: <CADPb22Qfo62gA-70Xqo8OUQUKs2U1qpBv-hnpJyAxF6eMnSobg@mail.gmail.com> (raw)
In-Reply-To: <53271DC0.3050405@redhat.com>
On Mon, Mar 17, 2014 at 9:07 AM, Pedro Alves <palves@redhat.com> wrote:
> IMO, a module's API documentation should be in its header file, as
> that's where the module's "public" contract is defined.
> Needing to peek at the module's implementation feels wrong to me.
> If the function's documentation isn't clear without looking
> at the function's body, something is already wrong with
> the comment.
It use to be that M-. took me to the function definition and its documentation.
I'm curious what other emacs+etags users do now.
next prev parent reply other threads:[~2014-03-18 15:59 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-03-15 19:45 Doug Evans
2014-03-16 9:51 ` Gerhard Gappmeier
2014-03-17 0:38 ` Yao Qi
2014-03-17 13:44 ` Joel Brobecker
2014-03-17 14:23 ` Sergio Durigan Junior
2014-03-17 16:09 ` Pedro Alves
2014-03-17 17:15 ` DJ Delorie
2014-03-17 21:59 ` Stan Shebs
2014-03-18 7:47 ` Ricard Wanderlof
2014-03-18 15:59 ` Doug Evans [this message]
2014-03-26 16:45 ` Doug Evans
2014-03-26 19:05 ` Doug Evans
2014-03-26 20:43 ` 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=CADPb22Qfo62gA-70Xqo8OUQUKs2U1qpBv-hnpJyAxF6eMnSobg@mail.gmail.com \
--to=dje@google.com \
--cc=gdb-patches@sourceware.org \
--cc=palves@redhat.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