diff options
| author | Markus Armbruster <armbru@redhat.com> | 2023-04-28 12:54:22 +0200 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2023-05-09 09:12:43 +0200 |
| commit | a87a9b4d4fc4dcfa2925b1b90474f0ec69d59edf (patch) | |
| tree | 7e9523039bd890daf82cd6b09a5097f8aea29642 /tests/qapi-schema/doc-good.out | |
| parent | 5962635561d3f6ce2740b2f2fa110ae796184365 (diff) | |
tests/qapi-schema/doc-good: Improve argument description tests
Improve the comments to better describe what they test.
Cover argument description starting on a new line indented. This
style isn't documented in docs/devel/qapi-code-gen.rst. qapi-gen.py
accepts it, but messes up indentation: it's stripped from the first
line, not subsequent ones. The next commit will fix this.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20230428105429.1687850-11-armbru@redhat.com>
Reviewed-by: Juan Quintela <quintela@redhat.com>
Diffstat (limited to 'tests/qapi-schema/doc-good.out')
| -rw-r--r-- | tests/qapi-schema/doc-good.out | 16 |
1 files changed, 9 insertions, 7 deletions
diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.out index afa48dcd94..2ba72ae558 100644 --- a/tests/qapi-schema/doc-good.out +++ b/tests/qapi-schema/doc-good.out @@ -104,7 +104,7 @@ doc symbol=Enum body= arg=one -The _one_ {and only} +The _one_ {and only}, description on the same line arg=two feature=enum-feat @@ -117,12 +117,13 @@ doc symbol=Base body= arg=base1 -the first member +description starts on a new line, +not indented doc symbol=Variant1 body= A paragraph -Another paragraph (but no @var: line) +Another paragraph @var1 is undocumented arg=var1 @@ -143,7 +144,8 @@ doc symbol=Alternate body= arg=i -an integer +description starts on the same line +remainder indented the same @b is undocumented arg=b @@ -156,10 +158,10 @@ doc symbol=cmd body= arg=arg1 -the first argument +description starts on a new line, + indented arg=arg2 -the second -argument +the second argument arg=arg3 feature=cmd-feat1 |