Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Joel Brobecker <brobecker@adacore.com>
To: Doug Evans <dje@google.com>
Cc: gdb-patches <gdb-patches@sourceware.org>
Subject: Re: [RFC] Stop putting function comments in foo.h
Date: Mon, 17 Mar 2014 13:44:00 -0000	[thread overview]
Message-ID: <20140317134435.GA4282@adacore.com> (raw)
In-Reply-To: <CADPb22QBBrYB70YoL-Aqyfi77gphGija4zK5mSgYckwfZ7e84g@mail.gmail.com>

> 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.

I have a preference, but only a slight one, towards putting the comments
in the .c file.

-- 
Joel


  parent reply	other threads:[~2014-03-17 13:44 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 [this message]
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
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=20140317134435.GA4282@adacore.com \
    --to=brobecker@adacore.com \
    --cc=dje@google.com \
    --cc=gdb-patches@sourceware.org \
    /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