motorhead/qemu
1
0
Fork 0
mirror of https://github.com/Motorhead1991/qemu.git synced 2025-07-27 04:13:53 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions

qapi/parser: add undocumented stub members to all_sections

Browse source 
Parser and doc generator cooperate on generating stub documentation for
undocumented members.  The parser makes up an ArgSection with an empty
description, and the doc generator makes up a description.

Right now, the made-up ArgSections go into doc.args.  However, the new
doc generator uses .all_sections, not .args.  So put them into
.all_sections, too.

Insert them right after existing 'member' sections.  If there are none,
insert directly after the leading section.

Doesn't affect the old generator, because that one doesn't use
.all_sections.

Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20250311034303.75779-60-jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Commit message rewritten]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
This commit is contained in:
John Snow 2025-03-10 23:42:57 -04:00 • committed by Markus Armbruster
parent 565274da10
commit 4d7d30b405
1 changed files with 16 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

17
scripts/qapi/parser.py
View file

@ -789,8 +789,23 @@ class QAPIDoc:
raise QAPISemError(member.info,
"%s '%s' lacks documentation"
% (member.role, member.name))
self.args[member.name] = QAPIDoc.ArgSection(
# Insert stub documentation section for missing member docs.
# TODO: drop when undocumented members are outlawed
section = QAPIDoc.ArgSection(
self.info, QAPIDoc.Kind.MEMBER, member.name)
self.args[member.name] = section
# Determine where to insert stub doc - it should go at the
# end of the members section(s), if any. Note that index 0
# is assumed to be an untagged intro section, even if it is
# empty.
index = 1
if len(self.all_sections) > 1:
while self.all_sections[index].kind == QAPIDoc.Kind.MEMBER:
index += 1
self.all_sections.insert(index, section)
self.args[member.name].connect(member)
def connect_feature(self, feature: 'QAPISchemaFeature') -> None: