From 6cf517c2c36acc2add2ae6ecb3336ed775519f6f Mon Sep 17 00:00:00 2001
From: jake <jake@f5534014-38df-0310-8fa8-9805f1628bb7>
Date: Tue, 20 May 2008 06:28:12 +0000
Subject: Clean up PTV cursor documentation.

git-svn-id: http://anonsvn.wireshark.org/wireshark/trunk@25321 f5534014-38df-0310-8fa8-9805f1628bb7
---
 epan/ptvcursor.h | 37 ++++++++++++++++++++-----------------
 1 file changed, 20 insertions(+), 17 deletions(-)

(limited to 'epan')

diff --git a/epan/ptvcursor.h b/epan/ptvcursor.h
index 9080a8b5be..d90d8dd8f9 100644
--- a/epan/ptvcursor.h
+++ b/epan/ptvcursor.h
@@ -39,20 +39,20 @@
 typedef struct ptvcursor ptvcursor_t;
 
 /* Allocates an initializes a ptvcursor_t with 3 variables:
- * 	proto_tree, tvbuff, and offset. */
+ * proto_tree, tvbuff, and offset. */
 ptvcursor_t*
-ptvcursor_new(proto_tree*, tvbuff_t*, gint);
+ptvcursor_new(proto_tree* tree, tvbuff_t* tvb, gint offset);
 
 /* Gets data from tvbuff, adds it to proto_tree, increments offset,
  * and returns proto_item* */
 proto_item*
-ptvcursor_add(ptvcursor_t*, int hf, gint length, gboolean endianness);
+ptvcursor_add(ptvcursor_t* ptvc, int hf, gint length, gboolean endianness);
 
 
 /* Gets data from tvbuff, adds it to proto_tree, *DOES NOT* increment
  * offset, and returns proto_item* */
 proto_item*
-ptvcursor_add_no_advance(ptvcursor_t*, int hf, gint length, gboolean endianness);
+ptvcursor_add_no_advance(ptvcursor_t* ptvc, int hf, gint length, gboolean endianness);
 
 /* Advance the ptvcursor's offset within its tvbuff without
  * adding anything to the proto_tree. */
@@ -61,15 +61,15 @@ ptvcursor_advance(ptvcursor_t* ptvc, gint length);
 
 /* Frees memory for ptvcursor_t, but nothing deeper than that. */
 void
-ptvcursor_free(ptvcursor_t*);
+ptvcursor_free(ptvcursor_t* ptvc);
 
 /* Returns tvbuff. */
 tvbuff_t*
-ptvcursor_tvbuff(ptvcursor_t*);
+ptvcursor_tvbuff(ptvcursor_t* ptvc);
 
 /* Returns current offset. */
 gint
-ptvcursor_current_offset(ptvcursor_t*);
+ptvcursor_current_offset(ptvcursor_t* ptvc);
 
 /* Returns the proto_tree* */
 proto_tree*
@@ -77,34 +77,37 @@ ptvcursor_tree(ptvcursor_t* ptvc);
 
 /* Sets a new proto_tree* for the ptvcursor_t */
 void
-ptvcursor_set_tree(ptvcursor_t* ptvc, proto_tree *tree);
+ptvcursor_set_tree(ptvcursor_t* ptvc, proto_tree* tree);
 
 /* push a subtree in the tree stack of the cursor */
-proto_tree* 
-ptvcursor_push_subtree(ptvcursor_t *ptvc, proto_item *it, gint ett_subtree);
+proto_tree*
+ptvcursor_push_subtree(ptvcursor_t* ptvc, proto_item* it, gint ett_subtree);
 
 /* pop a subtree in the tree stack of the cursor */
-void ptvcursor_pop_subtree(ptvcursor_t *ptvc);
+void
+ptvcursor_pop_subtree(ptvcursor_t* ptvc);
 
 /* Add an item to the tree and create a subtree
  * If the length is unknown, length may be defined as SUBTREE_UNDEFINED_LENGTH.
  * In this case, when the subtree will be closed, the parent item length will
  * be equal to the advancement of the cursor since the creation of the subtree.
  */
-proto_tree* ptvcursor_add_with_subtree(ptvcursor_t * ptvc, int hfindex, gint length,  
-gboolean little_endian, gint ett_subtree);
+proto_tree*
+ptvcursor_add_with_subtree(ptvcursor_t* ptvc, int hfindex, gint length,
+    gboolean little_endian, gint ett_subtree);
 
 /* Add a text node to the tree and create a subtree
  * If the length is unknown, length may be defined as SUBTREE_UNDEFINED_LENGTH.
  * In this case, when the subtree will be closed, the item length will be equal
  * to the advancement of the cursor since the creation of the subtree.
  */
-proto_tree * ptvcursor_add_text_with_subtree(ptvcursor_t * ptvc, gint length, 
-    gint ett_subtree, const char *format, ...);
+proto_tree*
+ptvcursor_add_text_with_subtree(ptvcursor_t* ptvc, gint length,
+    gint ett_subtree, const char* format, ...);
 
 /* Creates a subtree and adds it to the cursor as the working tree but does not
  * save the old working tree */
-proto_tree* 
-ptvcursor_set_subtree(ptvcursor_t *ptvc, proto_item *it, gint ett_subtree); 
+proto_tree*
+ptvcursor_set_subtree(ptvcursor_t* ptvc, proto_item* it, gint ett_subtree);
 
 #endif /* __PTVCURSOR_H__ */
-- 
cgit v1.2.3