summary refs log tree commit diff stats
path: root/scripts/qapi
diff options
context:
space:
mode:
authorJohn Snow <jsnow@redhat.com>2025-07-11 01:10:42 -0400
committerMarkus Armbruster <armbru@redhat.com>2025-07-14 12:02:58 +0200
commit2e51072ae5c0275733be748fbee3ce59df6d6261 (patch)
tree121a848b8c6f4c6288fa67ad5a957fcd25941cc0 /scripts/qapi
parent92227370eb3d844528e6d7bc2fb42525d8245eaf (diff)
downloadfocaccia-qemu-2e51072ae5c0275733be748fbee3ce59df6d6261.tar.gz
focaccia-qemu-2e51072ae5c0275733be748fbee3ce59df6d6261.zip
docs/qapi-domain: add return-nodesc
This form is used to annotate a return type without an accompanying
description, for when there is no "Returns:" information in the source
doc, but we have a return type we want to generate a cross-reference to.

The syntax is:

:return-nodesc: TypeName

It's primarily necessary because Sphinx always expects both a type and a
description for the prior form and will format it accordingly. To have a
reasonable rendering when the body is missing, we need to use a
different info field list entirely.

Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20250711051045.51110-2-jsnow@redhat.com>
Acked-by: Markus Armbruster <armbru@redhat.com>
[Long line wrapped]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Diffstat (limited to 'scripts/qapi')
0 files changed, 0 insertions, 0 deletions