| Message ID | 20230428105429.1687850-10-armbru@redhat.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | qapi: Reformat doc comments | expand |
Markus Armbruster <armbru@redhat.com> wrote: > 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> Reviewed-by: Juan Quintela <quintela@redhat.com>
diff --git a/tests/qapi-schema/doc-good.json b/tests/qapi-schema/doc-good.json index 74745fb405..445471daee 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 9dd65b9d92..afa48dcd94 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
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> --- tests/qapi-schema/doc-good.json | 4 +++- tests/qapi-schema/doc-good.out | 2 ++ 2 files changed, 5 insertions(+), 1 deletion(-)