README.dissector: Add proto_tree_add_bitmask_with_flags()
authorUli Heilmeier <uh@heilmeier.eu>
Sat, 30 Jul 2016 09:36:15 +0000 (11:36 +0200)
committerMichael Mann <mmann78@netscape.net>
Sat, 30 Jul 2016 16:21:11 +0000 (16:21 +0000)
Extend README with proto_tree_add_bitmask_with_flags() function.

Change-Id: Ia984080eda77ab93b063771d625bc45b5b0fc6d2
Reviewed-on: https://code.wireshark.org/review/16785
Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
Reviewed-by: Michael Mann <mmann78@netscape.net>
doc/README.dissector

index 94fa462d1c6a1e1ba9226b778536ab3e94236e56..18eda283d44680960781bb19ddca944597aa7ed0 100644 (file)
@@ -1423,6 +1423,10 @@ protocol or field labels to the proto_tree:
     proto_tree_add_bitmask_text(tree, tvb, offset, len, name, fallback,
         ett, fields, encoding, flags);
 
+    proto_item *
+    proto_tree_add_bitmask_with_flags(tree, tvb, offset, hf_hdr, ett,
+        fields, encoding, flags);
+
     proto_item*
     proto_tree_add_bits_item(tree, id, tvb, bit_offset, no_of_bits,
         encoding);
@@ -1971,6 +1975,11 @@ There are the following flags defined:
   BMT_NO_FALSE - boolean flags are only added to the title if they are set.
   BMT_NO_TFS - only add flag name to the title, do not use true_false_string
 
+The proto_tree_add_bitmask_with_flags() function is an extended version
+of the proto_tree_add_bitmask() function. It allows using flags to specify
+which fields will affect the top-level title. The flags are the
+same BMT_NO_* flags as used in the proto_tree_add_bitmask_text() function.
+
 The proto_tree_add_bitmask() behavior can be obtained by providing
 both 'name' and 'fallback' arguments as NULL, and a flags of
 (BMT_NO_FALSE|BMT_NO_TFS).