ShuriZma
/
xemu
mirror of https://github.com/xemu-project/xemu.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

tests/qapi-schema/doc-good: Improve a comment 

The QAPI generator doesn't reject undocumented members and
features (yet).  doc-good.json covers this, with clear "is
undocumented" notes to signal intent.

Except for @Variant1 member @var1, where it's "(but no @var: line)".
Less clear.  Replace by "@var1 is undocumented".

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20230428105429.1687850-10-armbru@redhat.com>
Reviewed-by: Juan Quintela <quintela@redhat.com>
This commit is contained in:
Markus Armbruster 2023-04-28 12:54:21 +02:00
parent 22bd6e9c15
commit 5962635561
2 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
tests/qapi-schema/doc-good.json
View File

@ -83,7 +83,9 @@
#
# A paragraph
#
# Another paragraph (but no @var: line)
# Another paragraph
#
# @var1 is undocumented
#
# Features:
# @variant1-feat: a feature

2
tests/qapi-schema/doc-good.out
View File

@ -123,6 +123,8 @@ doc symbol=Variant1
A paragraph
Another paragraph (but no @var: line)
@var1 is undocumented
arg=var1
feature=variant1-feat