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

[Markus Armbruster]

Peter Maydell <address@hidden> writes:

> Some qapi doc comments have forgotten the ':' after the
> @argument, like this:
>
> # @filename         Filename for the new image file
> # @size             Size of the virtual disk in bytes
>
> The result is that these are parsed as part of the body
> text and appear as a run-on line:
>   filename Filename for the new image file size Size of the virtual disk in 
> bytes"
> followed by
>   filename: string
>     Not documented
>   size: int
>     Not documented
>
> in the 'Members' section.
>
> Correct the formatting.
>
> Signed-off-by: Peter Maydell <address@hidden>
> Reviewed-by: Markus Armbruster <address@hidden>

The title sounds like it's just a tweak, but it actually fixes bugs in
the generated documentation.  Suggest to change the title to

    qapi: Fix incorrect "Not documented" claims in QMP documentation

R-by stands regardless.