diff options
| author | Marc-André Lureau <marcandre.lureau@redhat.com> | 2018-12-13 16:37:20 +0400 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2018-12-14 06:52:48 +0100 |
| commit | a35c9bf82aff4e80a90f0adfc7383d03749db0b6 (patch) | |
| tree | 8a27cdb33977b141cf15c1ca6ba6dd3c2a9b4876 /tests | |
| parent | 8ee06f61e13701a54a9f76ceadafc856d279cdb6 (diff) | |
qapi: add 'If:' condition to enum values documentation
Use a common function to generate the "If:..." line.
While at it, get rid of the existing \n\n (no idea why it was
there). Use a line-break in member description, this seems to look
slightly better in the plaintext version.
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Message-Id: <20181213123724.4866-19-marcandre.lureau@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Diffstat (limited to 'tests')
| -rw-r--r-- | tests/qapi-schema/doc-good.json | 4 | ||||
| -rw-r--r-- | tests/qapi-schema/doc-good.out | 1 | ||||
| -rw-r--r-- | tests/qapi-schema/doc-good.texi | 2 |
3 files changed, 5 insertions, 2 deletions
diff --git a/tests/qapi-schema/doc-good.json b/tests/qapi-schema/doc-good.json index 984cd8ed06..1cd4935710 100644 --- a/tests/qapi-schema/doc-good.json +++ b/tests/qapi-schema/doc-good.json @@ -55,7 +55,9 @@ # # @two is undocumented ## -{ 'enum': 'Enum', 'data': [ 'one', 'two' ], 'if': 'defined(IFCOND)' } +{ 'enum': 'Enum', 'data': + [ { 'name': 'one', 'if': 'defined(IFONE)' }, 'two' ], + 'if': 'defined(IFCOND)' } ## # @Base: diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.out index c2fc5c774a..53bd177f7d 100644 --- a/tests/qapi-schema/doc-good.out +++ b/tests/qapi-schema/doc-good.out @@ -11,6 +11,7 @@ enum QType module doc-good.json enum Enum member one + if ['defined(IFONE)'] member two if ['defined(IFCOND)'] object Base diff --git a/tests/qapi-schema/doc-good.texi b/tests/qapi-schema/doc-good.texi index e42eace474..405055b146 100644 --- a/tests/qapi-schema/doc-good.texi +++ b/tests/qapi-schema/doc-good.texi @@ -84,12 +84,12 @@ Examples: @table @asis @item @code{one} The @emph{one} @{and only@} +@*@b{If:} @code{defined(IFONE)} @item @code{two} Not documented @end table @code{two} is undocumented - @b{If:} @code{defined(IFCOND)} @end deftp |