This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: [RFC] Stop putting function comments in foo.h
- From: Doug Evans <dje at google dot com>
- To: Pedro Alves <palves at redhat dot com>
- Cc: gdb-patches <gdb-patches at sourceware dot org>
- Date: Tue, 18 Mar 2014 08:59:49 -0700
- Subject: Re: [RFC] Stop putting function comments in foo.h
- Authentication-results: sourceware.org; auth=none
- References: <CADPb22QBBrYB70YoL-Aqyfi77gphGija4zK5mSgYckwfZ7e84g at mail dot gmail dot com> <53271DC0 dot 3050405 at redhat dot 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.