linux-bluetooth.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Fabien Chevalier <fabchevalier@free.fr>
To: Marcel Holtmann <marcel@holtmann.org>
Cc: Johan Hedberg <johan.hedberg@nokia.com>,
	BlueZ development <bluez-devel@lists.sourceforge.net>
Subject: Re: [PATCH] Bluez exceptions refactoring updated patch
Date: Mon, 26 Nov 2007 17:12:13 +0100	[thread overview]
Message-ID: <474AF05D.70404@free.fr> (raw)
In-Reply-To: <1196056051.4217.51.camel@aeonflux>

Hi Marcel,

Please some comments below...

> Two comments on your patch itself. The copyright on common/error.[ch] is
> not only yours. Keep the original copyright of the files.

Well, that file didn't exit beforehand, so as far as nobody else but me 
has touched it, what's the point in putting everybody's copyright in it?
(OK, this is not true anymore as Johan made some changes you requested 
to it :-) )

> 
> It is great that you added comments for each function, but they belong
> inside the *.c files. The rule is that they should be placed where the
> actual function body is defined.

Marcel, i don't know where from you got this idea, but i find it pretty 
dumb. The whole point in having the documentation in the header file is 
that as a user of a function you're not interested in how it works (the 
c file), but what it does, which is what the documentation is for.

I don't know of *any* project that has it's function level documentation 
in the C files.
But there are numerous counter-examples:
   - The Linux Kernel (have a look at the USB stack file 
include/linux/usb.h for instance).
   - glib
   - libsig++
   - Qt
   - STL
   - ... ==> Do i need to find more ?

So, is there any good reason we should do differently from everybody 
else ? :-)

Cheers,

Fabien

  reply	other threads:[~2007-11-26 16:12 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-11-25 21:32 [PATCH] Bluez exceptions refactoring updated patch Fabien Chevalier
2007-11-26  5:47 ` [Bluez-devel] " Marcel Holtmann
2007-11-26 16:12   ` Fabien Chevalier [this message]
2007-11-27 20:54     ` Marcel Holtmann
2007-11-30  9:01       ` Fabien Chevalier
2007-11-30  9:41         ` Marcel Holtmann
2007-11-26 14:12 ` Johan Hedberg

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=474AF05D.70404@free.fr \
    --to=fabchevalier@free.fr \
    --cc=bluez-devel@lists.sourceforge.net \
    --cc=johan.hedberg@nokia.com \
    --cc=marcel@holtmann.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;
as well as URLs for NNTP newsgroup(s).