From: "Andreas Färber" <afaerber@suse.de>
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>
Subject: Re: [Qemu-devel] [PATCH v3] bitops.h: Add functions to extract and deposit bitfields
Date: Fri, 06 Jul 2012 16:17:58 +0200 [thread overview]
Message-ID: <4FF6F396.8020307@suse.de> (raw)
In-Reply-To: <CAFEAcA8yH4AHUeyksjFYcJOqTSZsESZ60jWC+2-MtCzH+dTG9A@mail.gmail.com>
Am 06.07.2012 16:01, schrieb Peter Maydell:
> On 6 July 2012 14:41, Andreas Färber <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
>
> 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
--
SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
GF: Jeff Hawn, Jennifer Guild, Felix Imendörffer; HRB 16746 AG Nürnberg
prev parent reply other threads:[~2012-07-06 14:18 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <1340888154-31903-1-git-send-email-peter.maydell@linaro.org>
2012-07-06 9:01 ` [Qemu-devel] [PATCH v3] bitops.h: Add functions to extract and deposit bitfields Peter Maydell
2012-07-06 13:41 ` Andreas Färber
2012-07-06 14:01 ` Peter Maydell
2012-07-06 14:17 ` Andreas Färber [this message]
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=4FF6F396.8020307@suse.de \
--to=afaerber@suse.de \
--cc=avi@redhat.com \
--cc=blauwirbel@gmail.com \
--cc=eblake@redhat.com \
--cc=jay.foad@gmail.com \
--cc=patches@linaro.org \
--cc=peter.maydell@linaro.org \
--cc=proljc@gmail.com \
--cc=qemu-devel@nongnu.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.