diff options
| author | Markus Armbruster <armbru@redhat.com> | 2017-03-15 13:57:01 +0100 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2017-03-16 07:13:02 +0100 |
| commit | 8c0aa61318a63d42099ee0e3d40e80e8108cbc21 (patch) | |
| tree | 8869c573fe5f3f296532b2f32698eb3deaed3711 /qapi | |
| parent | b116fd8e302d0ff7cabf431e78ce078127b51f85 (diff) | |
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>
Diffstat (limited to 'qapi')
| -rw-r--r-- | qapi/rocker.json | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/qapi/rocker.json b/qapi/rocker.json index 97e2b8376f..f374038c60 100644 --- a/qapi/rocker.json +++ b/qapi/rocker.json @@ -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 ## |