From: Markus Armbruster Date: Fri, 28 Apr 2023 10:54:21 +0000 (+0200) Subject: tests/qapi-schema/doc-good: Improve a comment X-Git-Tag: v8.1.0-rc0~134^2~8 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=5962635561d3f6ce2740b2f2fa110ae796184365;p=thirdparty%2Fqemu.git 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 Message-Id: <20230428105429.1687850-10-armbru@redhat.com> Reviewed-by: Juan Quintela --- diff --git a/tests/qapi-schema/doc-good.json b/tests/qapi-schema/doc-good.json index 74745fb4052..445471daee8 100644 --- a/tests/qapi-schema/doc-good.json +++ b/tests/qapi-schema/doc-good.json @@ -83,7 +83,9 @@ # # A paragraph # -# Another paragraph (but no @var: line) +# Another paragraph +# +# @var1 is undocumented # # Features: # @variant1-feat: a feature diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.out index 9dd65b9d92e..afa48dcd944 100644 --- a/tests/qapi-schema/doc-good.out +++ b/tests/qapi-schema/doc-good.out @@ -123,6 +123,8 @@ doc symbol=Variant1 A paragraph Another paragraph (but no @var: line) + +@var1 is undocumented arg=var1 feature=variant1-feat