]> git.ipfire.org Git - thirdparty/qemu.git/commitdiff
docs/qapidoc: generate entries for undocumented members
authorJohn Snow <jsnow@redhat.com>
Tue, 11 Mar 2025 03:42:56 +0000 (23:42 -0400)
committerMarkus Armbruster <armbru@redhat.com>
Tue, 11 Mar 2025 09:26:52 +0000 (10:26 +0100)
Presently, we never have any empty text entries for members. The next
patch will explicitly generate such sections, so enable support for it
in advance.

The parser will generate placeholder sections to indicate undocumented
members, but it's the qapidoc generator that's responsible for deciding
what to do with that stub section.

Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20250311034303.75779-59-jsnow@redhat.com>
Acked-by: Markus Armbruster <armbru@redhat.com>
[Tweak the stub section text]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
docs/sphinx/qapidoc.py

index a2d6f648a2e27c2a1d1f1ee18205432c36d070d6..432fef04b057f765d389757bca88685695cfc40b 100644 (file)
@@ -233,11 +233,12 @@ class Transmogrifier:
         # TODO: features for members (documented at entity-level,
         # but sometimes defined per-member. Should we add such
         # information to member descriptions when we can?)
-        assert section.text and section.member
+        assert section.member
         self.generate_field(
             self.member_field_type,
             section.member,
-            section.text,
+            # TODO drop fallbacks when undocumented members are outlawed
+            section.text if section.text else "Not documented",
             section.info,
         )