From a947ff39672fb4533ab91eae271e799a944106aa Mon Sep 17 00:00:00 2001
From: Tom Henderson <tomh@tomh.org>
Date: Fri, 30 May 2008 10:36:02 -0700
Subject: [PATCH] more doxygen

---
 doc/modules                       |  4 ++--
 src/common/chunk.h                |  2 ++
 src/common/header.h               |  2 +-
 src/node/address.h                |  5 +++++
 src/node/application.h            |  3 +++
 src/node/channel.h                |  3 +++
 src/node/drop-tail-queue.h        |  2 ++
 src/node/ethernet-header.h        |  2 ++
 src/node/ethernet-trailer.h       |  2 ++
 src/node/inet-socket-address.h    |  2 ++
 src/node/ipv4-address-generator.h |  6 ++++++
 src/node/ipv4-address.h           | 14 ++++++++++----
 src/node/ipv4-route.h             |  2 ++
 src/node/ipv4.h                   |  9 ++++++++-
 src/node/llc-snap-header.h        |  5 +++++
 src/node/mac48-address.h          |  2 ++
 src/node/mac64-address.h          |  2 ++
 src/node/net-device.h             |  6 ++++++
 src/node/node-list.h              |  2 ++
 src/node/node.h                   |  2 ++
 src/node/packet-socket-address.h  |  5 +++++
 src/node/packet-socket-factory.h  |  2 ++
 src/node/packet-socket.h          |  2 ++
 src/node/queue.h                  |  3 +++
 src/node/simple-channel.h         |  4 ++++
 src/node/simple-net-device.h      |  5 +++++
 src/node/socket-factory.h         |  2 ++
 src/node/tcp-socket-factory.h     |  2 ++
 src/node/tcp-socket.h             |  2 ++
 src/node/udp-socket-factory.h     |  2 ++
 src/node/udp-socket.h             |  2 ++
 31 files changed, 100 insertions(+), 8 deletions(-)

diff --git a/doc/modules b/doc/modules
index 2f55fff30..afc272c94 100644
--- a/doc/modules
+++ b/doc/modules
@@ -24,7 +24,7 @@
  *      in a simulation: ns3::Config.
  *
  * @defgroup common Common
- * The "core" module contains: 
+ * The "common" module contains: 
  *    - a packet class to create and manipulate simulation packets: 
  *      ns3::Packet, ns3::Header,  and ns3::Trailer. This packet class 
  *      also supports per-packet ns3::Tag which are  globs of data 
@@ -62,4 +62,4 @@
  * @brief Constants you can change
  *
  * @defgroup contrib Contrib
- */
\ No newline at end of file
+ */
diff --git a/src/common/chunk.h b/src/common/chunk.h
index 44bbe4545..63d62d283 100644
--- a/src/common/chunk.h
+++ b/src/common/chunk.h
@@ -8,6 +8,8 @@ namespace ns3 {
 
 /**
  * \ingroup packet
+ *
+ * \brief abstract base class for ns3::Header and ns3::Trailer
  */
 class Chunk : public ObjectBase
 {
diff --git a/src/common/header.h b/src/common/header.h
index cb44d3dae..8ad22c7e5 100644
--- a/src/common/header.h
+++ b/src/common/header.h
@@ -28,7 +28,7 @@
 namespace ns3 {
 
 /**
- * \ingroup Packet
+ * \ingroup packet
  *
  * \brief Protocol header serialization and deserialization.
  *
diff --git a/src/node/address.h b/src/node/address.h
index d88d5643d..9f69b5750 100644
--- a/src/node/address.h
+++ b/src/node/address.h
@@ -10,6 +10,11 @@
 namespace ns3 {
 
 /**
+ * \ingroup node
+ * \defgroup address Address
+ */
+/**
+ * \ingroup address
  * \brief a polymophic address class
  *
  * This class is very similar in design and spirit to the BSD sockaddr
diff --git a/src/node/application.h b/src/node/application.h
index d21ee6a50..2834847da 100644
--- a/src/node/application.h
+++ b/src/node/application.h
@@ -33,6 +33,9 @@ class Node;
 class RandomVariable;
 
 /**
+ * \ingroup node
+ * \defgroup application
+ *
  * \brief The base class for all ns3 applicationes
  * 
  * Class Application is the base class for all ns3 applications.
diff --git a/src/node/channel.h b/src/node/channel.h
index 28648841b..f0471360c 100644
--- a/src/node/channel.h
+++ b/src/node/channel.h
@@ -27,6 +27,9 @@ namespace ns3 {
 class NetDevice;
 
 /**
+ * \ingroup node
+ * \defgroup channel Channel
+ *
  * \brief Abstract Channel Base Class.
  *
  * A channel is a logical path over which information flows.  The path can
diff --git a/src/node/drop-tail-queue.h b/src/node/drop-tail-queue.h
index 4905a25af..0fe245105 100644
--- a/src/node/drop-tail-queue.h
+++ b/src/node/drop-tail-queue.h
@@ -28,6 +28,8 @@ namespace ns3 {
 class TraceContainer;
 
 /**
+ * \ingroup queue
+ *
  * \brief A FIFO packet queue that drops tail-end packets on overflow
  */
 class DropTailQueue : public Queue {
diff --git a/src/node/ethernet-header.h b/src/node/ethernet-header.h
index a006205f0..84c2ce27d 100644
--- a/src/node/ethernet-header.h
+++ b/src/node/ethernet-header.h
@@ -38,6 +38,8 @@ namespace ns3 {
     QINQ      /**< Double tagged packet. Header includes two VLAN tags */
   };
 /**
+ * \ingroup node
+ *
  * \brief Packet header for Ethernet
  *
  * This class can be used to add a header to an ethernet packet that
diff --git a/src/node/ethernet-trailer.h b/src/node/ethernet-trailer.h
index 6e9eb77bc..0508bc651 100644
--- a/src/node/ethernet-trailer.h
+++ b/src/node/ethernet-trailer.h
@@ -29,6 +29,8 @@ namespace ns3 {
 class Packet;
 
 /**
+ * \ingroup node
+ *
  * \brief Packet trailer for Ethernet
  *
  * This class can be used to add and verify the FCS at the end of an
diff --git a/src/node/inet-socket-address.h b/src/node/inet-socket-address.h
index 35a5cc83c..b775c1387 100644
--- a/src/node/inet-socket-address.h
+++ b/src/node/inet-socket-address.h
@@ -29,6 +29,8 @@ namespace ns3 {
 
 
 /**
+ * \ingroup address
+ *
  * \brief an Inet address class
  *
  * This class is similar to inet_sockaddr in the BSD socket
diff --git a/src/node/ipv4-address-generator.h b/src/node/ipv4-address-generator.h
index f88a89696..da23abae5 100644
--- a/src/node/ipv4-address-generator.h
+++ b/src/node/ipv4-address-generator.h
@@ -23,6 +23,12 @@
 
 namespace ns3 {
 
+/**
+ * \ingroup address
+ *
+ * \brief This generator assigns addresses sequentially from a provided
+ * network address; used in topology code.
+ */
 class Ipv4AddressGenerator {
 public:
   static void Init (const Ipv4Address net, const Ipv4Mask mask, 
diff --git a/src/node/ipv4-address.h b/src/node/ipv4-address.h
index 18898aeb1..8d5d24530 100644
--- a/src/node/ipv4-address.h
+++ b/src/node/ipv4-address.h
@@ -30,9 +30,11 @@ namespace ns3 {
 
 class Ipv4Mask;
 
-/** Ipv4 addresses are stored in host order in
-  * this class.
-  */
+/** 
+ * \ingroup address
+ *
+ * \brief Ipv4 addresses are stored in host order in this class.
+ */
 class Ipv4Address {
 public:
   Ipv4Address ();
@@ -144,7 +146,11 @@ private:
   friend bool operator < (Ipv4Address const &addrA, Ipv4Address const &addrB);
 };
 
-
+/**
+ * \ingroup address
+ *
+ * \brief a class to represent an Ipv4 address mask
+ */
 class Ipv4Mask {
 public:
   Ipv4Mask ();
diff --git a/src/node/ipv4-route.h b/src/node/ipv4-route.h
index f0badc2a0..6f2ce0349 100644
--- a/src/node/ipv4-route.h
+++ b/src/node/ipv4-route.h
@@ -28,6 +28,7 @@
 
 namespace ns3 {
 /**
+ * \ingroup ipv4
  * \brief A record of an IPv4 route
  */
 class Ipv4Route {
@@ -106,6 +107,7 @@ private:
 std::ostream& operator<< (std::ostream& os, Ipv4Route const& route);
 
 /**
+ * \ingroup ipv4 
  * \brief A record of an IPv4 multicast route
  */
 class Ipv4MulticastRoute {
diff --git a/src/node/ipv4.h b/src/node/ipv4.h
index 461c297d9..e743290db 100644
--- a/src/node/ipv4.h
+++ b/src/node/ipv4.h
@@ -32,10 +32,17 @@ class Node;
 class NetDevice;
 class Packet;
 class Ipv4Route;
-class Ipv4Header; // FIXME: ipv4-header.h needs to move from module
+class Ipv4Header; // XXX: ipv4-header.h needs to move from module
                   // "internet-node" to module "node"
 
 /**
+ * \ingroup node
+ * \defgroup ipv4 Ipv4
+ */
+
+/**
+ * \ingroup ipv4
+ *
  * \brief Base class for IPv4 routing protocols.
  *
  * This class represents the interface between the IPv4 routing core
diff --git a/src/node/llc-snap-header.h b/src/node/llc-snap-header.h
index f5cec7ebe..a4828fe3e 100644
--- a/src/node/llc-snap-header.h
+++ b/src/node/llc-snap-header.h
@@ -27,6 +27,11 @@
 
 namespace ns3 {
 
+/**
+ * \ingroup node
+ *
+ * \brief Header for the LLC/SNAP encapsulation
+ */
 class LlcSnapHeader : public Header 
 {
 public:
diff --git a/src/node/mac48-address.h b/src/node/mac48-address.h
index 75c356a8e..4572ab484 100644
--- a/src/node/mac48-address.h
+++ b/src/node/mac48-address.h
@@ -30,6 +30,8 @@ namespace ns3 {
 class Address;
 
 /**
+ * \ingroup address
+ * 
  * \brief an EUI-48 address
  *
  * This class can contain 48 bit IEEE addresses.
diff --git a/src/node/mac64-address.h b/src/node/mac64-address.h
index 67d3cfc2f..8d28e5efe 100644
--- a/src/node/mac64-address.h
+++ b/src/node/mac64-address.h
@@ -28,6 +28,8 @@ namespace ns3 {
 class Address;
 
 /**
+ * \ingroup address
+ *
  * \brief an EUI-64 address
  *
  * This class can contain 64 bit IEEE addresses.
diff --git a/src/node/net-device.h b/src/node/net-device.h
index 4f3e93d6c..34fefd654 100644
--- a/src/node/net-device.h
+++ b/src/node/net-device.h
@@ -36,6 +36,12 @@ class Channel;
 class Packet;
 
 /**
+ * \ingroup node
+ * \defgroup netdevice NetDevice
+ */
+/**
+ * \ingroup NetDevice
+ *
  * \brief Network layer to device interface
  *
  * This interface defines the API which the IP and ARP
diff --git a/src/node/node-list.h b/src/node/node-list.h
index 85395b414..137363dff 100644
--- a/src/node/node-list.h
+++ b/src/node/node-list.h
@@ -31,6 +31,8 @@ class CallbackBase;
 
 
 /**
+ * \ingroup node
+ *
  * \brief the list of simulation nodes.
  *
  * Every Node created is automatically added to this list.
diff --git a/src/node/node.h b/src/node/node.h
index 272d0f52c..ed0311871 100644
--- a/src/node/node.h
+++ b/src/node/node.h
@@ -36,6 +36,8 @@ class Address;
 
 
 /**
+ * \ingroup node
+ *
  * \brief A network Node.
  *
  * This class holds together:
diff --git a/src/node/packet-socket-address.h b/src/node/packet-socket-address.h
index 87f254e8c..9f99a9a63 100644
--- a/src/node/packet-socket-address.h
+++ b/src/node/packet-socket-address.h
@@ -30,6 +30,11 @@ namespace ns3 {
 
 class NetDevice;
 
+/**
+ * \ingroup address
+ *
+ * \brief an address for a packet socket
+ */
 class PacketSocketAddress
 {
  public:
diff --git a/src/node/packet-socket-factory.h b/src/node/packet-socket-factory.h
index e33a4bdb4..913d3ff8c 100644
--- a/src/node/packet-socket-factory.h
+++ b/src/node/packet-socket-factory.h
@@ -27,6 +27,8 @@ namespace ns3 {
 class Socket;
 
 /**
+ * \ingroup socket 
+ * 
  * This can be used as an interface in a node in order for the node to
  * generate PacketSockets that can connect to net devices.
  */
diff --git a/src/node/packet-socket.h b/src/node/packet-socket.h
index 680168f1e..31f8cd3fc 100644
--- a/src/node/packet-socket.h
+++ b/src/node/packet-socket.h
@@ -36,6 +36,8 @@ class NetDevice;
 class PacketSocketAddress;
 
 /**
+ * \ingroup socket
+ *
  * \brief A PacketSocket is a link between an application and a net device.
  *
  * A PacketSocket can be used to connect an application to a net
diff --git a/src/node/queue.h b/src/node/queue.h
index 5603245c4..dba69f5ad 100644
--- a/src/node/queue.h
+++ b/src/node/queue.h
@@ -33,6 +33,9 @@
 namespace ns3 {
 
 /**
+ * \ingroup node
+ * \defgroup queue Queue
+ *
  * \brief Abstract base class for packet Queues
  * 
  * This class defines the base APIs for packet queues in the ns-3 system
diff --git a/src/node/simple-channel.h b/src/node/simple-channel.h
index 526948e2e..4680e54ca 100644
--- a/src/node/simple-channel.h
+++ b/src/node/simple-channel.h
@@ -10,6 +10,10 @@ namespace ns3 {
 class SimpleNetDevice;
 class Packet;
 
+/**
+ * \ingroup channel
+ * \brief A simple channel, for simple things and testing
+ */
 class SimpleChannel : public Channel
 {
 public:
diff --git a/src/node/simple-net-device.h b/src/node/simple-net-device.h
index 84a255002..19ce5ef3a 100644
--- a/src/node/simple-net-device.h
+++ b/src/node/simple-net-device.h
@@ -30,6 +30,11 @@ namespace ns3 {
 class SimpleChannel;
 class Node;
 
+/**
+ * \ingroup netdevice
+ * 
+ * \brief simple net device for simple things and testing
+ */
 class SimpleNetDevice : public NetDevice
 {
 public:
diff --git a/src/node/socket-factory.h b/src/node/socket-factory.h
index 6062760ce..9f17bca6e 100644
--- a/src/node/socket-factory.h
+++ b/src/node/socket-factory.h
@@ -28,6 +28,8 @@ namespace ns3 {
 class Socket;
 
 /**
+ * \ingroup socket
+ *
  * \brief Object to create transport layer instances that provide a 
  * socket API to applications.
  *
diff --git a/src/node/tcp-socket-factory.h b/src/node/tcp-socket-factory.h
index 35909cb54..92cede256 100644
--- a/src/node/tcp-socket-factory.h
+++ b/src/node/tcp-socket-factory.h
@@ -27,6 +27,8 @@ namespace ns3 {
 class Socket;
 
 /**
+ * \ingroup socket
+ *
  * \brief API to create TCP socket instances 
  *
  * This abstract class defines the API for TCP sockets.
diff --git a/src/node/tcp-socket.h b/src/node/tcp-socket.h
index 9092474f4..14ef39c5d 100644
--- a/src/node/tcp-socket.h
+++ b/src/node/tcp-socket.h
@@ -36,6 +36,8 @@ class Node;
 class Packet;
 
 /**
+ * \ingroup socket
+ *
  * \brief (abstract) base class of all TcpSockets
  *
  * This class exists solely for hosting TcpSocket attributes that can
diff --git a/src/node/udp-socket-factory.h b/src/node/udp-socket-factory.h
index 32789c35a..4e2b74354 100644
--- a/src/node/udp-socket-factory.h
+++ b/src/node/udp-socket-factory.h
@@ -27,6 +27,8 @@ namespace ns3 {
 class Socket;
 
 /**
+ * \ingroup socket
+ *
  * \brief API to create UDP socket instances 
  *
  * This abstract class defines the API for UDP socket factory.
diff --git a/src/node/udp-socket.h b/src/node/udp-socket.h
index 1c81916c2..61d3d2685 100644
--- a/src/node/udp-socket.h
+++ b/src/node/udp-socket.h
@@ -35,6 +35,8 @@ class Node;
 class Packet;
 
 /**
+ * \ingroup socket
+ *
  * \brief (abstract) base class of all UdpSockets
  *
  * This class exists solely for hosting UdpSocket attributes that can