diff options
| author | Marc-André Lureau <marcandre.lureau@redhat.com> | 2018-07-03 17:56:46 +0200 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2018-07-03 18:38:54 +0200 |
| commit | 901a34a400a0dd5bf5056b6b9ecce48ab8eb02ac (patch) | |
| tree | 02017ab72a1a33e2032409afad76e53e1bb7ead3 /tests/qapi-schema | |
| parent | 9f88c66211342714b06c051140fd64ffd338dbe1 (diff) | |
| download | focaccia-qemu-901a34a400a0dd5bf5056b6b9ecce48ab8eb02ac.tar.gz focaccia-qemu-901a34a400a0dd5bf5056b6b9ecce48ab8eb02ac.zip | |
qapi: add 'If:' section to generated documentation
The documentation is generated only once, and doesn't know C pre-conditions. Add 'If:' sections for top-level entities. Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Reviewed-by: Markus Armbruster <armbru@redhat.com> Message-Id: <20180703155648.11933-13-marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
Diffstat (limited to 'tests/qapi-schema')
| -rw-r--r-- | tests/qapi-schema/doc-good.json | 2 | ||||
| -rw-r--r-- | tests/qapi-schema/doc-good.out | 1 | ||||
| -rw-r--r-- | tests/qapi-schema/doc-good.texi | 2 |
3 files changed, 4 insertions, 1 deletions
diff --git a/tests/qapi-schema/doc-good.json b/tests/qapi-schema/doc-good.json index 97ab4625ff..984cd8ed06 100644 --- a/tests/qapi-schema/doc-good.json +++ b/tests/qapi-schema/doc-good.json @@ -55,7 +55,7 @@ # # @two is undocumented ## -{ 'enum': 'Enum', 'data': [ 'one', 'two' ] } +{ 'enum': 'Enum', 'data': [ 'one', 'two' ], 'if': 'defined(IFCOND)' } ## # @Base: diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.out index 9c8a4838e1..35f3f1164c 100644 --- a/tests/qapi-schema/doc-good.out +++ b/tests/qapi-schema/doc-good.out @@ -3,6 +3,7 @@ enum QType ['none', 'qnull', 'qnum', 'qstring', 'qdict', 'qlist', 'qbool'] prefix QTYPE module doc-good.json enum Enum ['one', 'two'] + if ['defined(IFCOND)'] object Base member base1: Enum optional=False object Variant1 diff --git a/tests/qapi-schema/doc-good.texi b/tests/qapi-schema/doc-good.texi index 0aed2300a5..e42eace474 100644 --- a/tests/qapi-schema/doc-good.texi +++ b/tests/qapi-schema/doc-good.texi @@ -89,6 +89,8 @@ Not documented @end table @code{two} is undocumented + +@b{If:} @code{defined(IFCOND)} @end deftp |