From 062a2dcc427a245bf9bf5be5c44909132f328218 Mon Sep 17 00:00:00 2001 From: Mathieu Lacage Date: Thu, 24 Apr 2008 14:58:17 -0700 Subject: [PATCH] add a couple of dox comments --- src/common/packet.h | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/common/packet.h b/src/common/packet.h index d7825baa9..4c7665f8c 100644 --- a/src/common/packet.h +++ b/src/common/packet.h @@ -37,6 +37,8 @@ namespace ns3 { /** * \brief Iterator over the set of tags in a packet + * + * This is a java-style iterator. */ class TagIterator { @@ -81,7 +83,13 @@ public: 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;