Am 06.07.2012 16:01, schrieb Peter Maydell: > On 6 July 2012 14:41, Andreas Färber <afaer...@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
