| Message ID | 20200206173040.17337-12-peter.maydell@linaro.org |
|---|---|
| State | Superseded |
| Headers | show |
| Series | Convert QAPI doc comments to generate rST instead of texinfo | expand |
Peter Maydell <peter.maydell@linaro.org> writes: > In the doc comment for input-send-event, there is a multi-line > chunk of text ("The @device...take precedence") which is intended > to be the main body text describing the event. However it has > been placed after the arguments and Returns: section, which > means that the parser actually thinks that this text is > part of the "Returns" section text. > > Move the body text up to the top so that the parser correctly > classifies it as body. > > Signed-off-by: Peter Maydell <peter.maydell@linaro.org> > --- > qapi/ui.json | 14 +++++++------- > 1 file changed, 7 insertions(+), 7 deletions(-) > > diff --git a/qapi/ui.json b/qapi/ui.json > index aced267a1e4..94a07318f55 100644 > --- a/qapi/ui.json > +++ b/qapi/ui.json > @@ -949,13 +949,6 @@ > # > # Send input event(s) to guest. > # > -# @device: display device to send event(s) to. > -# @head: head to send event(s) to, in case the > -# display device supports multiple scanouts. > -# @events: List of InputEvent union. > -# > -# Returns: Nothing on success. > -# > # The @device and @head parameters can be used to send the input event > # to specific input devices in case (a) multiple input devices of the > # same kind are added to the virtual machine and (b) you have > @@ -967,6 +960,13 @@ > # are admissible, but devices with input routing config take > # precedence. > # > +# @device: display device to send event(s) to. > +# @head: head to send event(s) to, in case the > +# display device supports multiple scanouts. > +# @events: List of InputEvent union. > +# > +# Returns: Nothing on success. > +# > # Since: 2.6 > # > # Note: The consoles are visible in the qom tree, under Reviewed-by: Markus Armbruster <armbru@redhat.com>
diff --git a/qapi/ui.json b/qapi/ui.json index aced267a1e4..94a07318f55 100644 --- a/qapi/ui.json +++ b/qapi/ui.json @@ -949,13 +949,6 @@ # # Send input event(s) to guest. # -# @device: display device to send event(s) to. -# @head: head to send event(s) to, in case the -# display device supports multiple scanouts. -# @events: List of InputEvent union. -# -# Returns: Nothing on success. -# # The @device and @head parameters can be used to send the input event # to specific input devices in case (a) multiple input devices of the # same kind are added to the virtual machine and (b) you have @@ -967,6 +960,13 @@ # are admissible, but devices with input routing config take # precedence. # +# @device: display device to send event(s) to. +# @head: head to send event(s) to, in case the +# display device supports multiple scanouts. +# @events: List of InputEvent union. +# +# Returns: Nothing on success. +# # Since: 2.6 # # Note: The consoles are visible in the qom tree, under
In the doc comment for input-send-event, there is a multi-line chunk of text ("The @device...take precedence") which is intended to be the main body text describing the event. However it has been placed after the arguments and Returns: section, which means that the parser actually thinks that this text is part of the "Returns" section text. Move the body text up to the top so that the parser correctly classifies it as body. Signed-off-by: Peter Maydell <peter.maydell@linaro.org> --- qapi/ui.json | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) -- 2.20.1