From 0785e918e2d932889edb25d50c79821cd2fdecf7 Mon Sep 17 00:00:00 2001
From: Tom Wambold <tom5760@gmail.com>
Date: Fri, 11 Sep 2009 12:11:23 -0400
Subject: [PATCH] PacketBB: A bit more documentation.

---
 src/node/packetbb.cc |  7 +++----
 src/node/packetbb.h  | 17 ++++++++++-------
 2 files changed, 13 insertions(+), 11 deletions(-)

diff --git a/src/node/packetbb.cc b/src/node/packetbb.cc
index 0b5a92a36..4eeb13356 100644
--- a/src/node/packetbb.cc
+++ b/src/node/packetbb.cc
@@ -18,10 +18,9 @@
  * 
  * Author: Tom Wambold <tom5760@gmail.com>
  */
-/* TODO:
- * - Check style
- * - Check copy constructors
- */
+/* These classes implement RFC 5444 - The Generalized Mobile Ad Hoc Network
+ * (MANET) Packet/PbbMessage Format
+ * See: http://tools.ietf.org/html/rfc5444 for details */
 
 #include "ns3/ipv4-address.h"
 #include "ns3/ipv6-address.h"
diff --git a/src/node/packetbb.h b/src/node/packetbb.h
index fd5ee6570..45e720ece 100644
--- a/src/node/packetbb.h
+++ b/src/node/packetbb.h
@@ -47,7 +47,7 @@ enum PbbAddressLength {
 };
 
 /**
- * \brief A block of Packet or PbbMessage TLVs.
+ * \brief A block of packet or message TLVs (PbbTlv).
  *
  * Acts similar to a C++ STL container.  Should not be used for Address TLVs.
  */
@@ -196,7 +196,7 @@ private:
 };
 
 /**
- * \brief A block of Address TLVs.
+ * \brief A block of Address TLVs (PbbAddressTlv).
  *
  * Acts similar to a C++ STL container.
  */
@@ -349,6 +349,9 @@ private:
 /**
  * \brief Main PacketBB Packet object.
  *
+ * A PacketBB packet is made up of zero or more packet TLVs (PbbTlv), and zero
+ * or more messages (PbbMessage).
+ *
  * See: http://tools.ietf.org/html/rfc5444 for details.
  */
 class PbbPacket : public Header
@@ -640,9 +643,9 @@ private:
 /**
  * \brief A message within a PbbPacket packet.
  *
- * There may be any number of messages in one PbbPacket packet.
- * This is a pure virutal base class, you should instantiate either PbbMessageIpv4
- * or PbbMessageIpv6.
+ * There may be any number of messages in one packet packet.  This is a pure
+ * virutal base class, when creating a message, you should instantiate either
+ * PbbMessageIpv4 or PbbMessageIpv6.
  */
 class PbbMessage
 {
@@ -1075,8 +1078,8 @@ protected:
 /**
  * \brief An Address Block and its associated Address TLV Blocks.
  *
- * This is a pure virtual base class, you should instantiate either
- * PbbAddressBlockIpv4 or PbbAddressBlockIpv6.
+ * This is a pure virtual base class, when creating address blocks, you should
+ * instantiate either PbbAddressBlockIpv4 or PbbAddressBlockIpv6.
  */
 class PbbAddressBlock
 {