Re: [PATCH 08/29] qapi: Use ':' after @argument in doc comments

[Kevin Wolf]

Am 07.02.2020 um 10:28 hat Markus Armbruster geschrieben:
> Peter Maydell <address@hidden> writes:
> > @@ -4703,7 +4703,7 @@
> >  #
> >  # Options for creating an image format on a given node.
> >  #
> > -# @driver           block driver to create the image format
> > +# @driver: block driver to create the image format
> >  #
> >  # Since: 2.12
> >  ##
> 
> Loses the visual alignment.  I'm okay with that, but the folks who took
> the trouble to align the text may have different ideas.  Cc'ing Kevin
> and Max.

I think the documentation is much easier to parse visually with aligned
text as it makes both the option name and the whole part of the comment
that documents options stand out clearly.

Of course, "It is the QEMU coding style." would trump everything, but as
long as there isn't a style guide that requires a wall of text without
spaces and alignment, I'd prefer to leave at least those aligned texts
in place that we have.

Kevin