From mboxrd@z Thu Jan  1 00:00:00 1970
Received: from eggs.gnu.org ([2001:4830:134:3::10]:35464)
	by lists.gnu.org with esmtp (Exim 4.71)
	(envelope-from <pbonzini@redhat.com>) id 1V75xc-0007ob-MR
	for qemu-devel@nongnu.org; Wed, 07 Aug 2013 11:47:46 -0400
Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)
	(envelope-from <pbonzini@redhat.com>) id 1V75xW-0007qA-NV
	for qemu-devel@nongnu.org; Wed, 07 Aug 2013 11:47:40 -0400
Received: from mx1.redhat.com ([209.132.183.28]:13731)
	by eggs.gnu.org with esmtp (Exim 4.71)
	(envelope-from <pbonzini@redhat.com>) id 1V75xW-0007px-B7
	for qemu-devel@nongnu.org; Wed, 07 Aug 2013 11:47:34 -0400
Date: Wed, 7 Aug 2013 17:47:15 +0200
From: Paolo Bonzini <pbonzini@redhat.com>
Message-ID: <20130807154715.GD11916@mail.corp.redhat.com>
References: <1375832956-7588-1-git-send-email-alex@alex.org.uk>
	<1375832956-7588-2-git-send-email-alex@alex.org.uk>
	<20130807113107.GA29076@stefanha-thinkpad.redhat.com>
	<270E3E8BF6C6FD89B1DCC485@nimrod.local>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
In-Reply-To: <270E3E8BF6C6FD89B1DCC485@nimrod.local>
Subject: Re: [Qemu-devel] [RFC] [PATCHv7 01/22] aio / timers: Add
 qemu_clock_free and expose qemu_clock_new and clock types
List-Id: <qemu-devel.nongnu.org>
List-Unsubscribe: <https://lists.nongnu.org/mailman/options/qemu-devel>,
	<mailto:qemu-devel-request@nongnu.org?subject=unsubscribe>
List-Archive: <http://lists.nongnu.org/archive/html/qemu-devel>
List-Post: <mailto:qemu-devel@nongnu.org>
List-Help: <mailto:qemu-devel-request@nongnu.org?subject=help>
List-Subscribe: <https://lists.nongnu.org/mailman/listinfo/qemu-devel>,
	<mailto:qemu-devel-request@nongnu.org?subject=subscribe>
To: Alex Bligh <alex@alex.org.uk>
Cc: Kevin Wolf <kwolf@redhat.com>, Anthony Liguori <aliguori@us.ibm.com>, Stefan Hajnoczi <stefanha@gmail.com>, qemu-devel@nongnu.org, liu ping fan <qemulist@gmail.com>, Stefan Hajnoczi <stefanha@redhat.com>, MORITA Kazutaka <morita.kazutaka@lab.ntt.co.jp>, rth@twiddle.net

On Aug 07 2013, Alex Bligh wrote:
> 
> --On 7 August 2013 13:31:07 +0200 Stefan Hajnoczi
> <stefanha@gmail.com> wrote:
> 
> > Regarding doc comments: if the function is self-documenting then the doc
> > comment might not add much.  I think in those cases it's okay to omit
> > details about arguments or return values if they are clear from the
> > function prototype.
> 
> Given I've done them for every function, I hope they don't cause any
> active harm. I was concerned that with an API change some things that
> one might have thought were obvious are in fact not obvious (e.g.
> timer_del vs. timer_free).

No, they definitely do not harm.

Paolo