[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 11/29] qapi/ui.json: Put input-send-event body text in the right
From: |
Peter Maydell |
Subject: |
[PATCH 11/29] qapi/ui.json: Put input-send-event body text in the right place |
Date: |
Thu, 6 Feb 2020 17:30:22 +0000 |
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 <address@hidden>
---
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
--
2.20.1
- Re: [PATCH 08/29] qapi: Use ':' after @argument in doc comments, (continued)
- Re: [PATCH 08/29] qapi: Use ':' after @argument in doc comments, Markus Armbruster, 2020/02/07
- Re: [PATCH 08/29] qapi: Use ':' after @argument in doc comments, Max Reitz, 2020/02/07
- Re: [PATCH 08/29] qapi: Use ':' after @argument in doc comments, Kevin Wolf, 2020/02/07
- Re: [PATCH 08/29] qapi: Use ':' after @argument in doc comments, Peter Maydell, 2020/02/07
- Re: [PATCH 08/29] qapi: Use ':' after @argument in doc comments, Markus Armbruster, 2020/02/07
- Re: [PATCH 08/29] qapi: Use ':' after @argument in doc comments, Max Reitz, 2020/02/07
- Re: [PATCH 08/29] qapi: Use ':' after @argument in doc comments, Kevin Wolf, 2020/02/07
- Re: [PATCH 08/29] qapi: Use ':' after @argument in doc comments, Peter Maydell, 2020/02/07
- Re: [PATCH 08/29] qapi: Use ':' after @argument in doc comments, Markus Armbruster, 2020/02/08
- Re: [PATCH 08/29] qapi: Use ':' after @argument in doc comments, Peter Maydell, 2020/02/08
[PATCH 11/29] qapi/ui.json: Put input-send-event body text in the right place,
Peter Maydell <=
[PATCH 13/29] qapi/ui.json: Avoid `...' texinfo style quoting, Peter Maydell, 2020/02/06
[PATCH 12/29] qapi: Explicitly put "foo: dropped in n.n" notes into Notes section, Peter Maydell, 2020/02/06
[PATCH 10/29] qapi: Remove hardcoded tabs, Peter Maydell, 2020/02/06
[PATCH 15/29] qapi/ui.json: Use explicit bulleted lists, Peter Maydell, 2020/02/06
[PATCH 17/29] qapi: Add blank lines before bulleted lists, Peter Maydell, 2020/02/06