From mboxrd@z Thu Jan  1 00:00:00 1970
Received: from eggs.gnu.org ([2001:4830:134:3::10]:48685)
	by lists.gnu.org with esmtp (Exim 4.71)
	(envelope-from <stefanha@gmail.com>) id 1V6iIA-0006Uc-Qf
	for qemu-devel@nongnu.org; Tue, 06 Aug 2013 10:31:27 -0400
Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)
	(envelope-from <stefanha@gmail.com>) id 1V6iHv-0007VD-R9
	for qemu-devel@nongnu.org; Tue, 06 Aug 2013 10:31:18 -0400
Received: from mail-we0-x22c.google.com ([2a00:1450:400c:c03::22c]:40095)
	by eggs.gnu.org with esmtp (Exim 4.71)
	(envelope-from <stefanha@gmail.com>) id 1V6iHv-0007Uu-KU
	for qemu-devel@nongnu.org; Tue, 06 Aug 2013 10:31:03 -0400
Received: by mail-we0-f172.google.com with SMTP id t61so449109wes.3
	for <qemu-devel@nongnu.org>; Tue, 06 Aug 2013 07:31:03 -0700 (PDT)
Date: Tue, 6 Aug 2013 16:31:00 +0200
From: Stefan Hajnoczi <stefanha@gmail.com>
Message-ID: <20130806143100.GC4373@stefanha-thinkpad.redhat.com>
References: <1375639805-1943-1-git-send-email-alex@alex.org.uk>
	<1375780592-22842-1-git-send-email-alex@alex.org.uk>
	<1375780592-22842-6-git-send-email-alex@alex.org.uk>
	<20130806122633.GC30812@stefanha-thinkpad.redhat.com>
	<74A60C73F7A6DC56B86792A7@nimrod.local>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <74A60C73F7A6DC56B86792A7@nimrod.local>
Subject: Re: [Qemu-devel] [RFC] [PATCHv6 05/16] aio / timers: Split
 QEMUClock into QEMUClock and QEMUTimerList
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>, qemu-devel@nongnu.org, liu ping fan <qemulist@gmail.com>, Stefan Hajnoczi <stefanha@redhat.com>, Paolo Bonzini <pbonzini@redhat.com>, MORITA Kazutaka <morita.kazutaka@lab.ntt.co.jp>, rth@twiddle.net

On Tue, Aug 06, 2013 at 02:16:02PM +0100, Alex Bligh wrote:
> --On 6 August 2013 14:26:33 +0200 Stefan Hajnoczi
> <stefanha@redhat.com> wrote:
> 
> >Please use doc comments (see include/object/qom.h for example doc
> >comment syntax).
> 
> Should these go in the .h (per include/qom/object.h) or the .c (per
> your comment)?

I don't think there is a strict rule.

I like putting doc comments in the .c file for non-external APIs.  That
way it's easier to remember that the doc comment needs to be updated if
the function is modified.

Stefan