diff options
| author | Marc-André Lureau <marcandre.lureau@redhat.com> | 2018-12-13 16:37:21 +0400 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2018-12-14 06:52:48 +0100 |
| commit | 8867bf08087a3d508a0ecce661f7e430c1747022 (patch) | |
| tree | c9404cc5c0afe4469cc1fedd60c810332b71743d | |
| parent | a35c9bf82aff4e80a90f0adfc7383d03749db0b6 (diff) | |
| download | focaccia-qemu-8867bf08087a3d508a0ecce661f7e430c1747022.tar.gz focaccia-qemu-8867bf08087a3d508a0ecce661f7e430c1747022.zip | |
qapi: add 'If:' condition to struct members documentation
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Message-Id: <20181213123724.4866-20-marcandre.lureau@redhat.com> Reviewed-by: Markus Armbruster <armbru@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
| -rwxr-xr-x | scripts/qapi/doc.py | 4 | ||||
| -rw-r--r-- | tests/qapi-schema/doc-good.json | 3 | ||||
| -rw-r--r-- | tests/qapi-schema/doc-good.out | 1 | ||||
| -rw-r--r-- | tests/qapi-schema/doc-good.texi | 1 |
4 files changed, 6 insertions, 3 deletions
diff --git a/scripts/qapi/doc.py b/scripts/qapi/doc.py index ab36b9dec6..b6f834b917 100755 --- a/scripts/qapi/doc.py +++ b/scripts/qapi/doc.py @@ -143,10 +143,10 @@ def texi_member(member, desc, suffix): """Format a table of members item for an object type member""" typ = member.type.doc_type() membertype = ': ' + typ if typ else '' - return '@item @code{%s%s}%s%s\n%s' % ( + return '@item @code{%s%s}%s%s\n%s%s' % ( member.name, membertype, ' (optional)' if member.optional else '', - suffix, desc) + suffix, desc, texi_if(member.ifcond, prefix='@*')) def texi_members(doc, what, base, variants, member_func): diff --git a/tests/qapi-schema/doc-good.json b/tests/qapi-schema/doc-good.json index 1cd4935710..28992fc615 100644 --- a/tests/qapi-schema/doc-good.json +++ b/tests/qapi-schema/doc-good.json @@ -72,7 +72,8 @@ # # Another paragraph (but no @var: line) ## -{ 'struct': 'Variant1', 'data': { 'var1': 'str' } } +{ 'struct': 'Variant1', + 'data': { 'var1': { 'type': 'str', 'if': 'defined(IFSTR)' } } } ## # @Variant2: diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.out index 53bd177f7d..4ab55683ce 100644 --- a/tests/qapi-schema/doc-good.out +++ b/tests/qapi-schema/doc-good.out @@ -18,6 +18,7 @@ object Base member base1: Enum optional=False object Variant1 member var1: str optional=False + if ['defined(IFSTR)'] object Variant2 object Object base Base diff --git a/tests/qapi-schema/doc-good.texi b/tests/qapi-schema/doc-good.texi index 405055b146..f87f9faacb 100644 --- a/tests/qapi-schema/doc-good.texi +++ b/tests/qapi-schema/doc-good.texi @@ -119,6 +119,7 @@ Another paragraph (but no @code{var}: line) @table @asis @item @code{var1: string} Not documented +@*@b{If:} @code{defined(IFSTR)} @end table @end deftp |