From mboxrd@z Thu Jan  1 00:00:00 1970
Received: from eggs.gnu.org ([208.118.235.92]:36237)
	by lists.gnu.org with esmtp (Exim 4.71)
	(envelope-from <afaerber@suse.de>) id 1Sn9MH-0001rh-RK
	for qemu-devel@nongnu.org; Fri, 06 Jul 2012 10:18:15 -0400
Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)
	(envelope-from <afaerber@suse.de>) id 1Sn9MB-0004xV-Fz
	for qemu-devel@nongnu.org; Fri, 06 Jul 2012 10:18:09 -0400
Received: from cantor2.suse.de ([195.135.220.15]:53757 helo=mx2.suse.de)
	by eggs.gnu.org with esmtp (Exim 4.71)
	(envelope-from <afaerber@suse.de>) id 1Sn9MB-0004xL-9o
	for qemu-devel@nongnu.org; Fri, 06 Jul 2012 10:18:03 -0400
Message-ID: <4FF6F396.8020307@suse.de>
Date: Fri, 06 Jul 2012 16:17:58 +0200
From: =?UTF-8?B?QW5kcmVhcyBGw6RyYmVy?= <afaerber@suse.de>
MIME-Version: 1.0
References: <1340888154-31903-1-git-send-email-peter.maydell@linaro.org>
	<4FF6EB13.3070107@suse.de>
	<CAFEAcA8yH4AHUeyksjFYcJOqTSZsESZ60jWC+2-MtCzH+dTG9A@mail.gmail.com>
In-Reply-To: <CAFEAcA8yH4AHUeyksjFYcJOqTSZsESZ60jWC+2-MtCzH+dTG9A@mail.gmail.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: quoted-printable
Subject: Re: [Qemu-devel] [PATCH v3] bitops.h: Add functions to extract and
 deposit bitfields
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: Peter Maydell <peter.maydell@linaro.org>
Cc: Jia Liu <proljc@gmail.com>, patches@linaro.org, Jay Foad <jay.foad@gmail.com>, qemu-devel@nongnu.org, Blue Swirl <blauwirbel@gmail.com>, Avi Kivity <avi@redhat.com>, Eric Blake <eblake@redhat.com>

Am 06.07.2012 16:01, schrieb Peter Maydell:
> On 6 July 2012 14:41, Andreas F=C3=A4rber <afaerber@suse.de> wrote:
>> Small improvement would be to replace "Returns the" with "Returns: The=
"
>> in line with how you annotated the arguments, and the function summary
>> should go into its own paragraph between @foo: and Returns:.
>>
>> http://developer.gnome.org/gtk-doc-manual/unstable/documenting_symbols=
.html.en
>=20
> Hmm. I was just following the existing practice in this file,
> which consistently uses "Returns $whatever" without a colon.
> memory.h uses "Returns $whatever" rather than "Returns: $whatever"
> too. But I guess the doc you link to is the official statement
> of the required syntax. How are these comments?

Looking fine. Didn't know about the "existing practice", I picked up
Anthony's object.h style and remembered adjusting that in qom-next.

Andreas

--=20
SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 N=C3=BCrnberg, Germany
GF: Jeff Hawn, Jennifer Guild, Felix Imend=C3=B6rffer; HRB 16746 AG N=C3=BC=
rnberg