[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 13/18] qapi/ui.json: Put input-send-event body text in the right p
From: |
Markus Armbruster |
Subject: |
[PULL 13/18] qapi/ui.json: Put input-send-event body text in the right place |
Date: |
Sat, 15 Feb 2020 12:41:28 +0100 |
From: Peter Maydell <address@hidden>
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>
Reviewed-by: Markus Armbruster <address@hidden>
Message-Id: <address@hidden>
Signed-off-by: Markus Armbruster <address@hidden>
---
qapi/ui.json | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/qapi/ui.json b/qapi/ui.json
index ba873e1e29..e8b8b708c7 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.21.1
- [PULL 00/18] QAPI patches for 2020-02-15, Markus Armbruster, 2020/02/15
- [PULL 01/18] qapi: Expand documentation for LostTickPolicy, Markus Armbruster, 2020/02/15
- [PULL 06/18] qga/qapi-schema.json: Fix missing '-' in GuestDiskBusType doc comment, Markus Armbruster, 2020/02/15
- [PULL 07/18] qga/qapi-schema.json: Fix indent level on doc comments, Markus Armbruster, 2020/02/15
- [PULL 05/18] Makefile: Fix typo in dependency list for interop manpages, Markus Armbruster, 2020/02/15
- [PULL 13/18] qapi/ui.json: Put input-send-event body text in the right place,
Markus Armbruster <=
- [PULL 03/18] configure: Pick sphinx-build-3 when available, Markus Armbruster, 2020/02/15
- [PULL 18/18] qapi: Delete all the "foo: dropped in n.n" notes, Markus Armbruster, 2020/02/15
- [PULL 10/18] qapi: Fix incorrect "Not documented" claims in QMP documentation, Markus Armbruster, 2020/02/15
- [PULL 14/18] qapi/ui.json: Avoid `...' Texinfo style quoting, Markus Armbruster, 2020/02/15
- [PULL 02/18] configure: Allow user to specify sphinx-build binary, Markus Armbruster, 2020/02/15
- [PULL 16/18] qapi: Add blank lines before bulleted lists, Markus Armbruster, 2020/02/15
- [PULL 09/18] qapi/block-core.json: Use literal block for ascii art, Markus Armbruster, 2020/02/15
- [PULL 08/18] qga/qapi-schema.json: minor format fixups for rST, Markus Armbruster, 2020/02/15
- [PULL 15/18] qapi: Use explicit bulleted lists, Markus Armbruster, 2020/02/15
- [PULL 17/18] qapi/migration.json: Replace _this_ with *this*, Markus Armbruster, 2020/02/15