# HG changeset patch
# User Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
# Date 1209074297 25200
# Node ID 8e29fb88ad26383c68951a0be62bcaabd7faafbd
# Parent  644bfc099992c0193007a0f44b771150253e16ef
add a couple of dox comments

diff -r 644bfc099992 -r 8e29fb88ad26 src/common/packet.h
--- a/src/common/packet.h	Thu Apr 24 14:52:59 2008 -0700
+++ b/src/common/packet.h	Thu Apr 24 14:58:17 2008 -0700
@@ -37,6 +37,8 @@
 
 /**
  * \brief Iterator over the set of tags in a packet
+ *
+ * This is a java-style iterator.
  */
 class TagIterator
 {
@@ -81,7 +83,13 @@
     uint32_t m_end;
     MtagBuffer m_buffer;
   };
+  /**
+   * \returns true if calling Next is safe, false otherwise.
+   */
   bool HasNext (void) const;
+  /**
+   * \returns the next item found and prepare for the next one.
+   */
   Item Next (void);
 private:
   friend class Packet;