diff mbox series

[RFC,v2,17/35] docs/qapi-domain: add returns-nodesc

Message ID 20241213011307.2942030-18-jsnow@redhat.com (mailing list archive)
State New
Headers show
Series Add qapi-domain Sphinx extension | expand

Commit Message

John Snow Dec. 13, 2024, 1:12 a.m. UTC 
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.

Signed-off-by: John Snow <jsnow@redhat.com>
---
 docs/sphinx/qapi-domain.py | 8 ++++++++
 1 file changed, 8 insertions(+)
diff mbox series

Patch

diff --git a/docs/sphinx/qapi-domain.py b/docs/sphinx/qapi-domain.py
index c8c8ffc0dce..c46c87168bd 100644
--- a/docs/sphinx/qapi-domain.py
+++ b/docs/sphinx/qapi-domain.py
@@ -275,6 +275,14 @@  class QAPICommand(QAPIObject):
                 names=("return", "returns"),
                 can_collapse=True,
             ),
+            # :returns-nodesc: TypeName
+            Field(
+                "returnvalue",
+                label=_("Returns"),
+                names=("returns-nodesc",),
+                bodyrolename="type",
+                has_arg=False,
+            ),
         ]
     )