PacketBB: A bit more documentation.
authorTom Wambold <tom5760@gmail.com>
Fri Sep 11 12:11:23 2009 -0400 (5 months ago)
changeset 4787523ffdd11c77
parent 4786 48c1400fbed1
child 4788 543507c4d939
PacketBB: A bit more documentation.
src/node/packetbb.cc
src/node/packetbb.h
     1.1 --- a/src/node/packetbb.cc	Fri Sep 11 12:00:38 2009 -0400
     1.2 +++ b/src/node/packetbb.cc	Fri Sep 11 12:11:23 2009 -0400
     1.3 @@ -18,10 +18,9 @@
     1.4   * 
     1.5   * Author: Tom Wambold <tom5760@gmail.com>
     1.6   */
     1.7 -/* TODO:
     1.8 - * - Check style
     1.9 - * - Check copy constructors
    1.10 - */
    1.11 +/* These classes implement RFC 5444 - The Generalized Mobile Ad Hoc Network
    1.12 + * (MANET) Packet/PbbMessage Format
    1.13 + * See: http://tools.ietf.org/html/rfc5444 for details */
    1.14  
    1.15  #include "ns3/ipv4-address.h"
    1.16  #include "ns3/ipv6-address.h"
     2.1 --- a/src/node/packetbb.h	Fri Sep 11 12:00:38 2009 -0400
     2.2 +++ b/src/node/packetbb.h	Fri Sep 11 12:11:23 2009 -0400
     2.3 @@ -47,7 +47,7 @@
     2.4  };
     2.5  
     2.6  /**
     2.7 - * \brief A block of Packet or PbbMessage TLVs.
     2.8 + * \brief A block of packet or message TLVs (PbbTlv).
     2.9   *
    2.10   * Acts similar to a C++ STL container.  Should not be used for Address TLVs.
    2.11   */
    2.12 @@ -196,7 +196,7 @@
    2.13  };
    2.14  
    2.15  /**
    2.16 - * \brief A block of Address TLVs.
    2.17 + * \brief A block of Address TLVs (PbbAddressTlv).
    2.18   *
    2.19   * Acts similar to a C++ STL container.
    2.20   */
    2.21 @@ -349,6 +349,9 @@
    2.22  /**
    2.23   * \brief Main PacketBB Packet object.
    2.24   *
    2.25 + * A PacketBB packet is made up of zero or more packet TLVs (PbbTlv), and zero
    2.26 + * or more messages (PbbMessage).
    2.27 + *
    2.28   * See: http://tools.ietf.org/html/rfc5444 for details.
    2.29   */
    2.30  class PbbPacket : public Header
    2.31 @@ -640,9 +643,9 @@
    2.32  /**
    2.33   * \brief A message within a PbbPacket packet.
    2.34   *
    2.35 - * There may be any number of messages in one PbbPacket packet.
    2.36 - * This is a pure virutal base class, you should instantiate either PbbMessageIpv4
    2.37 - * or PbbMessageIpv6.
    2.38 + * There may be any number of messages in one packet packet.  This is a pure
    2.39 + * virutal base class, when creating a message, you should instantiate either
    2.40 + * PbbMessageIpv4 or PbbMessageIpv6.
    2.41   */
    2.42  class PbbMessage
    2.43  {
    2.44 @@ -1075,8 +1078,8 @@
    2.45  /**
    2.46   * \brief An Address Block and its associated Address TLV Blocks.
    2.47   *
    2.48 - * This is a pure virtual base class, you should instantiate either
    2.49 - * PbbAddressBlockIpv4 or PbbAddressBlockIpv6.
    2.50 + * This is a pure virtual base class, when creating address blocks, you should
    2.51 + * instantiate either PbbAddressBlockIpv4 or PbbAddressBlockIpv6.
    2.52   */
    2.53  class PbbAddressBlock
    2.54  {