qapi: rephrase return docs to avoid type name

"Returns: <description>" is rendered like "Return: <Type> –
<description>".  Mentioning the type in the description again is
commonly redundant.  Rephrase such descriptions not to.

Well, I tried. Maybe not very hard. Sorry!

Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20250711051045.51110-5-jsnow@redhat.com>
Acked-by: Markus Armbruster <armbru@redhat.com>
[Commit message amended to explain why]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
This commit is contained in:
John Snow
2025-07-11 01:10:45 -04:00
committed by Markus Armbruster
parent 0462da9d6b
commit f7296f8de5
17 changed files with 28 additions and 34 deletions

View File

@@ -49,7 +49,7 @@
#
# @name: Event name pattern (case-sensitive glob).
#
# Returns: a list of @TraceEventInfo for the matching events
# Returns: a list of info for the matching events
#
# Since: 2.2
#