Document the proto_tree_add_XXX_format_value() routines.

svn path=/trunk/; revision=17318

1 files changed, 81 insertions, 0 deletions

diff --git a/doc/README.developer b/doc/README.developer
index 2a52d2c053..91a7561bb6 100644
--- a/doc/README.developer
+++ b/doc/README.developer
@@ -1623,6 +1623,10 @@ protocol or field labels to the proto_tree:
 	    format, ...);
 
 	proto_item *
+	proto_tree_add_bytes_format_value(tree, id, tvb, start, length,
+	    start_ptr, format, ...);
+
+	proto_item *
 	proto_tree_add_time(tree, id, tvb, start, length, value_ptr);
 
 	proto_item *
@@ -1633,6 +1637,10 @@ protocol or field labels to the proto_tree:
 	    format, ...);
 
 	proto_item *
+	proto_tree_add_time_format_value(tree, id, tvb, start, length,
+	    value_ptr, format, ...);
+
+	proto_item *
 	proto_tree_add_ipxnet(tree, id, tvb, start, length, value);
 
 	proto_item *
@@ -1643,6 +1651,10 @@ protocol or field labels to the proto_tree:
 	    format, ...);
 
 	proto_item *
+	proto_tree_add_ipxnet_format_value(tree, id, tvb, start, length,
+	    value, format, ...);
+
+	proto_item *
 	proto_tree_add_ipv4(tree, id, tvb, start, length, value);
 
 	proto_item *
@@ -1653,6 +1665,10 @@ protocol or field labels to the proto_tree:
 	    format, ...);
 
 	proto_item *
+	proto_tree_add_ipv4_format_value(tree, id, tvb, start, length,
+	    value, format, ...);
+
+	proto_item *
 	proto_tree_add_ipv6(tree, id, tvb, start, length, value_ptr);
 
 	proto_item *
@@ -1663,6 +1679,10 @@ protocol or field labels to the proto_tree:
 	    format, ...);
 
 	proto_item *
+	proto_tree_add_ipv6_format_value(tree, id, tvb, start, length,
+	    value_ptr, format, ...);
+
+	proto_item *
 	proto_tree_add_ether(tree, id, tvb, start, length, value_ptr);
 
 	proto_item *
@@ -1673,6 +1693,10 @@ protocol or field labels to the proto_tree:
 	    format, ...);
 
 	proto_item *
+	proto_tree_add_ether_format_value(tree, id, tvb, start, length,
+	    value_ptr, format, ...);
+
+	proto_item *
 	proto_tree_add_string(tree, id, tvb, start, length, value_ptr);
 
 	proto_item *
@@ -1683,6 +1707,10 @@ protocol or field labels to the proto_tree:
 	    format, ...);
 
 	proto_item *
+	proto_tree_add_string_format_value(tree, id, tvb, start, length,
+	    value_ptr, format, ...);
+
+	proto_item *
 	proto_tree_add_boolean(tree, id, tvb, start, length, value);
 
 	proto_item *
@@ -1693,6 +1721,10 @@ protocol or field labels to the proto_tree:
 	    format, ...);
 
 	proto_item *
+	proto_tree_add_boolean_format_value(tree, id, tvb, start, length,
+	    value, format, ...);
+
+	proto_item *
 	proto_tree_add_float(tree, id, tvb, start, length, value);
 
 	proto_item *
@@ -1703,6 +1735,10 @@ protocol or field labels to the proto_tree:
 	    format, ...);
 
 	proto_item *
+	proto_tree_add_float_format_value(tree, id, tvb, start, length,
+	    value, format, ...);
+
+	proto_item *
 	proto_tree_add_double(tree, id, tvb, start, length, value);
 
 	proto_item *
@@ -1713,6 +1749,10 @@ protocol or field labels to the proto_tree:
 	    format, ...);
 
 	proto_item *
+	proto_tree_add_double_format_value(tree, id, tvb, start, length,
+	    value, format, ...);
+
+	proto_item *
 	proto_tree_add_uint(tree, id, tvb, start, length, value);
 
 	proto_item *
@@ -1723,6 +1763,10 @@ protocol or field labels to the proto_tree:
 	    format, ...);
 
 	proto_item *
+	proto_tree_add_uint_format_value(tree, id, tvb, start, length,
+	    value, format, ...);
+
+	proto_item *
 	proto_tree_add_uint64(tree, id, tvb, start, length, value);
 
 	proto_item *
@@ -1730,6 +1774,10 @@ protocol or field labels to the proto_tree:
 	    format, ...);
 
 	proto_item *
+	proto_tree_add_uint64_format_value(tree, id, tvb, start, length,
+	    value, format, ...);
+
+	proto_item *
 	proto_tree_add_int(tree, id, tvb, start, length, value);
 
 	proto_item *
@@ -1740,12 +1788,20 @@ protocol or field labels to the proto_tree:
 	    format, ...);
 
 	proto_item *
+	proto_tree_add_int_format_value(tree, id, tvb, start, length,
+	    value, format, ...);
+
+	proto_item *
 	proto_tree_add_int64(tree, id, tvb, start, length, value);
 
 	proto_item *
 	proto_tree_add_int64_format(tree, id, tvb, start, length, value,
 	    format, ...);
 
+	proto_item *
+	proto_tree_add_int64_format_value(tree, id, tvb, start, length,
+	    value, format, ...);
+
 	proto_item*
 	proto_tree_add_text(tree, tvb, start, length, format, ...);
 
@@ -2006,6 +2062,31 @@ the arguments are a "printf"-style format and any arguments for that
 format.  The caller must include the name of the field in the format; it
 is not added automatically as in the proto_tree_add_XXX() functions.
 
+proto_tree_add_bytes_format_value()
+proto_tree_add_time_format_value()
+proto_tree_add_ipxnet_format_value()
+proto_tree_add_ipv4_format_value()
+proto_tree_add_ipv6_format_value()
+proto_tree_add_ether_format_value()
+proto_tree_add_string_format_value()
+proto_tree_add_boolean_format_value()
+proto_tree_add_float_format_value()
+proto_tree_add_double_format_value()
+proto_tree_add_uint_format_value()
+proto_tree_add_uint64_format_value()
+proto_tree_add_int_format_value()
+proto_tree_add_int64_format_value()
+----------------------------
+
+These routines are used to add items to the protocol tree when the
+dissector routines wants complete control over how the value will be
+represented on the GUI tree.  The argument giving the value is the same
+as the corresponding proto_tree_add_XXX() function; the rest of the
+arguments are a "printf"-style format and any arguments for that format. 
+With these routines, unlike the proto_tree_add_XXX_format() routines,
+the name of the field is added automatically as in the
+proto_tree_add_XXX() functions; only the value is added with the format.
+
 proto_tree_add_text()
 ---------------------
 proto_tree_add_text() is used to add a label to the GUI tree.  It will