ShuriZma
/
xemu
mirror of https://github.com/xemu-project/xemu.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

qapi/rocker: Fix up doc comment notes on optional members 

Talking about #optional like this

    # Note: fields are marked #optional to indicate that they may or may
    # not appear ...

doesn't work so well in generated documentation, because the #optional
tag is not visible there.  Replace by

    # Note: optional members may or may not appear ...

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Message-Id: <1489582656-31133-13-git-send-email-armbru@redhat.com>
This commit is contained in:
Markus Armbruster 2017-03-15 13:57:01 +01:00
parent b116fd8e30
commit 8c0aa61318
1 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
qapi/rocker.json
View File

@ -1,3 +1,5 @@
# -*- Mode: Python -*-
##
# = Rocker switch device
##
@ -137,8 +139,8 @@
#
# @ip-dst: #optional IP header destination address
#
# Note: fields are marked #optional to indicate that they may or may not
# appear in the flow key depending if they're relevant to the flow key.
# Note: optional members may or may not appear in the flow key
# depending if they're relevant to the flow key.
#
# Since: 2.4
##
@ -167,8 +169,8 @@
#
# @ip-tos: #optional IP header TOS field
#
# Note: fields are marked #optional to indicate that they may or may not
# appear in the flow mask depending if they're relevant to the flow mask.
# Note: optional members may or may not appear in the flow mask
# depending if they're relevant to the flow mask.
#
# Since: 2.4
##
@ -194,8 +196,8 @@
#
# @out-pport: #optional physical output port
#
# Note: fields are marked #optional to indicate that they may or may not
# appear in the flow action depending if they're relevant to the flow action.
# Note: optional members may or may not appear in the flow action
# depending if they're relevant to the flow action.
#
# Since: 2.4
##
@ -288,8 +290,8 @@
#
# @ttl-check: #optional perform TTL check
#
# Note: fields are marked #optional to indicate that they may or may not
# appear in the group depending if they're relevant to the group type.
# Note: optional members may or may not appear in the group depending
# if they're relevant to the group type.
#
# Since: 2.4
##