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>
This commit is contained in:
Marc-André Lureau 2018-12-13 16:37:20 +04:00 committed by Markus Armbruster
parent 8ee06f61e1
commit a35c9bf82a
4 changed files with 21 additions and 11 deletions

View file

@ -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:

View file

@ -11,6 +11,7 @@ enum QType
module doc-good.json
enum Enum
member one
if ['defined(IFONE)']
member two
if ['defined(IFCOND)']
object Base

View file

@ -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