qga/qapi-schema: Clean up "Returns" sections

Drop "on success" where it is redundant with "Returns:".

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240227113921.236097-11-armbru@redhat.com>
This commit is contained in:
Markus Armbruster 2024-02-27 12:39:18 +01:00
parent 3630a47903
commit 6a90cc82b5
1 changed files with 8 additions and 8 deletions

View File

@ -228,7 +228,7 @@
# #
# @mode: open mode, as per fopen(), "r" is the default. # @mode: open mode, as per fopen(), "r" is the default.
# #
# Returns: Guest file handle on success. # Returns: Guest file handle
# #
# Since: 0.15.0 # Since: 0.15.0
## ##
@ -277,7 +277,7 @@
# @count: maximum number of bytes to read (default is 4KB, maximum is # @count: maximum number of bytes to read (default is 4KB, maximum is
# 48MB) # 48MB)
# #
# Returns: @GuestFileRead on success. # Returns: @GuestFileRead
# #
# Since: 0.15.0 # Since: 0.15.0
## ##
@ -312,7 +312,7 @@
# @count: bytes to write (actual bytes, after base64-decode), default # @count: bytes to write (actual bytes, after base64-decode), default
# is all content in buf-b64 buffer after base64 decoding # is all content in buf-b64 buffer after base64 decoding
# #
# Returns: @GuestFileWrite on success. # Returns: @GuestFileWrite
# #
# Since: 0.15.0 # Since: 0.15.0
## ##
@ -379,7 +379,7 @@
# #
# @whence: Symbolic or numeric code for interpreting offset # @whence: Symbolic or numeric code for interpreting offset
# #
# Returns: @GuestFileSeek on success. # Returns: @GuestFileSeek
# #
# Since: 0.15.0 # Since: 0.15.0
## ##
@ -723,7 +723,7 @@
# #
# Get list of guest IP addresses, MAC addresses and netmasks. # Get list of guest IP addresses, MAC addresses and netmasks.
# #
# Returns: List of GuestNetworkInterface on success. # Returns: List of GuestNetworkInterface
# #
# Since: 1.1 # Since: 1.1
## ##
@ -1247,7 +1247,7 @@
# #
# @pid: pid returned from guest-exec # @pid: pid returned from guest-exec
# #
# Returns: GuestExecStatus on success. # Returns: GuestExecStatus
# #
# Since: 2.5 # Since: 2.5
## ##
@ -1315,7 +1315,7 @@
# @capture-output: bool flag to enable capture of stdout/stderr of # @capture-output: bool flag to enable capture of stdout/stderr of
# running process. defaults to false. # running process. defaults to false.
# #
# Returns: PID on success. # Returns: PID
# #
# Since: 2.5 # Since: 2.5
## ##
@ -1344,7 +1344,7 @@
# or even present in DNS or some other name service at all. It need # or even present in DNS or some other name service at all. It need
# not even be unique on your local network or site, but usually it is. # not even be unique on your local network or site, but usually it is.
# #
# Returns: the host name of the machine on success # Returns: the host name of the machine
# #
# Since: 2.10 # Since: 2.10
## ##