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: Yao Qi <yao at codesourcery dot com>
- To: Doug Evans <dje at google dot com>
- Cc: gdb-patches <gdb-patches at sourceware dot org>
- Date: Mon, 17 Mar 2014 08:36:00 +0800
- 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>
On 03/16/2014 03:45 AM, Doug Evans wrote:
> Hi.
>
> I'd like to start a discussion.
> With doxygen is there still as much value to putting function comments
> in foo.h instead of foo.c?
>
> I ask because every time I find a "See foo.h." comment I get depressed
> and disappointed. They're just getting in my way, and I'm wondering
> if it's just me.
>
No, it isn't. I dislike the "See foo.h" comment either. Since we had
all source code available, it is convenient to read function comments in
foo.c when we are editing it.
--
Yao (éå)