diff options
| author | Markus Armbruster <armbru@redhat.com> | 2023-04-28 12:54:21 +0200 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2023-05-09 09:12:34 +0200 |
| commit | 5962635561d3f6ce2740b2f2fa110ae796184365 (patch) | |
| tree | 10317e301751ce995b6bb46f348d1c05d17bc6ca /tests/qapi-schema | |
| parent | 22bd6e9c152ae49de62a91f295bd9fc670806aca (diff) | |
| download | qemu-5962635561d3f6ce2740b2f2fa110ae796184365.zip qemu-5962635561d3f6ce2740b2f2fa110ae796184365.tar.gz qemu-5962635561d3f6ce2740b2f2fa110ae796184365.tar.bz2 | |
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>
Diffstat (limited to 'tests/qapi-schema')
| -rw-r--r-- | tests/qapi-schema/doc-good.json | 4 | ||||
| -rw-r--r-- | tests/qapi-schema/doc-good.out | 2 |
2 files changed, 5 insertions, 1 deletions
diff --git a/tests/qapi-schema/doc-good.json b/tests/qapi-schema/doc-good.json index 74745fb..445471d 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 9dd65b9..afa48dc 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 |