qapi/rocker: Supply missing member documentation
authorMarkus Armbruster <armbru@redhat.com>
Wed, 11 Sep 2024 11:25:43 +0000 (13:25 +0200)
committerMarkus Armbruster <armbru@redhat.com>
Wed, 2 Oct 2024 07:10:01 +0000 (09:10 +0200)
Since we neglect to document the argument of query-rocker and
query-rocker-ports, their description in the QEMU QMP Reference manual
is "Not documented".  Fix that.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
Message-ID: <20240911112545.2248881-7-armbru@redhat.com>

qapi/pragma.json
qapi/rocker.json

index baeae5bf527bb3d3cb88769583b128177dbbd46f..feb798170009a9a90926454918e1fe23287cd2b4 100644 (file)
@@ -78,9 +78,7 @@
         'X86CPURegister32',
         'XDbgBlockGraph',
         'YankInstanceType',
-        'blockdev-reopen',
-        'query-rocker',
-        'query-rocker-ports' ],
+        'blockdev-reopen' ],
     # Externally visible types whose member names may use uppercase
     'member-name-exceptions': [     # visible in:
         'ACPISlotType',             # query-acpi-ospm-status
index 73c7363b164dd0ba411c66dc0ea846188c2378fd..51aa5b493076bc0f8fb8f8e344085ad21b2b4f53 100644 (file)
@@ -26,6 +26,8 @@
 #
 # Return rocker switch information.
 #
+# @name: switch name
+#
 # Returns: @Rocker information
 #
 # Since: 2.4
@@ -94,6 +96,8 @@
 #
 # Return rocker switch port information.
 #
+# @name: port name
+#
 # Returns: a list of @RockerPort information
 #
 # Since: 2.4