--- a/doc/modules Thu May 29 23:24:10 2008 -0700
+++ b/doc/modules Fri May 30 10:36:02 2008 -0700
@@ -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
+ */
--- a/src/common/chunk.h Thu May 29 23:24:10 2008 -0700
+++ b/src/common/chunk.h Fri May 30 10:36:02 2008 -0700
@@ -8,6 +8,8 @@
/**
* \ingroup packet
+ *
+ * \brief abstract base class for ns3::Header and ns3::Trailer
*/
class Chunk : public ObjectBase
{
--- a/src/common/header.h Thu May 29 23:24:10 2008 -0700
+++ b/src/common/header.h Fri May 30 10:36:02 2008 -0700
@@ -28,7 +28,7 @@
namespace ns3 {
/**
- * \ingroup Packet
+ * \ingroup packet
*
* \brief Protocol header serialization and deserialization.
*
--- a/src/node/address.h Thu May 29 23:24:10 2008 -0700
+++ b/src/node/address.h Fri May 30 10:36:02 2008 -0700
@@ -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
--- a/src/node/application.h Thu May 29 23:24:10 2008 -0700
+++ b/src/node/application.h Fri May 30 10:36:02 2008 -0700
@@ -33,6 +33,9 @@
class RandomVariable;
/**
+ * \ingroup node
+ * \defgroup application
+ *
* \brief The base class for all ns3 applicationes
*
* Class Application is the base class for all ns3 applications.
--- a/src/node/channel.h Thu May 29 23:24:10 2008 -0700
+++ b/src/node/channel.h Fri May 30 10:36:02 2008 -0700
@@ -27,6 +27,9 @@
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
--- a/src/node/drop-tail-queue.h Thu May 29 23:24:10 2008 -0700
+++ b/src/node/drop-tail-queue.h Fri May 30 10:36:02 2008 -0700
@@ -28,6 +28,8 @@
class TraceContainer;
/**
+ * \ingroup queue
+ *
* \brief A FIFO packet queue that drops tail-end packets on overflow
*/
class DropTailQueue : public Queue {
--- a/src/node/ethernet-header.h Thu May 29 23:24:10 2008 -0700
+++ b/src/node/ethernet-header.h Fri May 30 10:36:02 2008 -0700
@@ -38,6 +38,8 @@
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
--- a/src/node/ethernet-trailer.h Thu May 29 23:24:10 2008 -0700
+++ b/src/node/ethernet-trailer.h Fri May 30 10:36:02 2008 -0700
@@ -29,6 +29,8 @@
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
--- a/src/node/inet-socket-address.h Thu May 29 23:24:10 2008 -0700
+++ b/src/node/inet-socket-address.h Fri May 30 10:36:02 2008 -0700
@@ -29,6 +29,8 @@
/**
+ * \ingroup address
+ *
* \brief an Inet address class
*
* This class is similar to inet_sockaddr in the BSD socket
--- a/src/node/ipv4-address-generator.h Thu May 29 23:24:10 2008 -0700
+++ b/src/node/ipv4-address-generator.h Fri May 30 10:36:02 2008 -0700
@@ -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,
--- a/src/node/ipv4-address.h Thu May 29 23:24:10 2008 -0700
+++ b/src/node/ipv4-address.h Fri May 30 10:36:02 2008 -0700
@@ -30,9 +30,11 @@
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 @@
friend bool operator < (Ipv4Address const &addrA, Ipv4Address const &addrB);
};
-
+/**
+ * \ingroup address
+ *
+ * \brief a class to represent an Ipv4 address mask
+ */
class Ipv4Mask {
public:
Ipv4Mask ();
--- a/src/node/ipv4-route.h Thu May 29 23:24:10 2008 -0700
+++ b/src/node/ipv4-route.h Fri May 30 10:36:02 2008 -0700
@@ -28,6 +28,7 @@
namespace ns3 {
/**
+ * \ingroup ipv4
* \brief A record of an IPv4 route
*/
class Ipv4Route {
@@ -106,6 +107,7 @@
std::ostream& operator<< (std::ostream& os, Ipv4Route const& route);
/**
+ * \ingroup ipv4
* \brief A record of an IPv4 multicast route
*/
class Ipv4MulticastRoute {
--- a/src/node/ipv4.h Thu May 29 23:24:10 2008 -0700
+++ b/src/node/ipv4.h Fri May 30 10:36:02 2008 -0700
@@ -32,10 +32,17 @@
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
--- a/src/node/llc-snap-header.h Thu May 29 23:24:10 2008 -0700
+++ b/src/node/llc-snap-header.h Fri May 30 10:36:02 2008 -0700
@@ -27,6 +27,11 @@
namespace ns3 {
+/**
+ * \ingroup node
+ *
+ * \brief Header for the LLC/SNAP encapsulation
+ */
class LlcSnapHeader : public Header
{
public:
--- a/src/node/mac48-address.h Thu May 29 23:24:10 2008 -0700
+++ b/src/node/mac48-address.h Fri May 30 10:36:02 2008 -0700
@@ -30,6 +30,8 @@
class Address;
/**
+ * \ingroup address
+ *
* \brief an EUI-48 address
*
* This class can contain 48 bit IEEE addresses.
--- a/src/node/mac64-address.h Thu May 29 23:24:10 2008 -0700
+++ b/src/node/mac64-address.h Fri May 30 10:36:02 2008 -0700
@@ -28,6 +28,8 @@
class Address;
/**
+ * \ingroup address
+ *
* \brief an EUI-64 address
*
* This class can contain 64 bit IEEE addresses.
--- a/src/node/net-device.h Thu May 29 23:24:10 2008 -0700
+++ b/src/node/net-device.h Fri May 30 10:36:02 2008 -0700
@@ -36,6 +36,12 @@
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
--- a/src/node/node-list.h Thu May 29 23:24:10 2008 -0700
+++ b/src/node/node-list.h Fri May 30 10:36:02 2008 -0700
@@ -31,6 +31,8 @@
/**
+ * \ingroup node
+ *
* \brief the list of simulation nodes.
*
* Every Node created is automatically added to this list.
--- a/src/node/node.h Thu May 29 23:24:10 2008 -0700
+++ b/src/node/node.h Fri May 30 10:36:02 2008 -0700
@@ -36,6 +36,8 @@
/**
+ * \ingroup node
+ *
* \brief A network Node.
*
* This class holds together:
--- a/src/node/packet-socket-address.h Thu May 29 23:24:10 2008 -0700
+++ b/src/node/packet-socket-address.h Fri May 30 10:36:02 2008 -0700
@@ -30,6 +30,11 @@
class NetDevice;
+/**
+ * \ingroup address
+ *
+ * \brief an address for a packet socket
+ */
class PacketSocketAddress
{
public:
--- a/src/node/packet-socket-factory.h Thu May 29 23:24:10 2008 -0700
+++ b/src/node/packet-socket-factory.h Fri May 30 10:36:02 2008 -0700
@@ -27,6 +27,8 @@
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.
*/
--- a/src/node/packet-socket.h Thu May 29 23:24:10 2008 -0700
+++ b/src/node/packet-socket.h Fri May 30 10:36:02 2008 -0700
@@ -36,6 +36,8 @@
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
--- a/src/node/queue.h Thu May 29 23:24:10 2008 -0700
+++ b/src/node/queue.h Fri May 30 10:36:02 2008 -0700
@@ -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
--- a/src/node/simple-channel.h Thu May 29 23:24:10 2008 -0700
+++ b/src/node/simple-channel.h Fri May 30 10:36:02 2008 -0700
@@ -10,6 +10,10 @@
class SimpleNetDevice;
class Packet;
+/**
+ * \ingroup channel
+ * \brief A simple channel, for simple things and testing
+ */
class SimpleChannel : public Channel
{
public:
--- a/src/node/simple-net-device.h Thu May 29 23:24:10 2008 -0700
+++ b/src/node/simple-net-device.h Fri May 30 10:36:02 2008 -0700
@@ -30,6 +30,11 @@
class SimpleChannel;
class Node;
+/**
+ * \ingroup netdevice
+ *
+ * \brief simple net device for simple things and testing
+ */
class SimpleNetDevice : public NetDevice
{
public:
--- a/src/node/socket-factory.h Thu May 29 23:24:10 2008 -0700
+++ b/src/node/socket-factory.h Fri May 30 10:36:02 2008 -0700
@@ -28,6 +28,8 @@
class Socket;
/**
+ * \ingroup socket
+ *
* \brief Object to create transport layer instances that provide a
* socket API to applications.
*
--- a/src/node/tcp-socket-factory.h Thu May 29 23:24:10 2008 -0700
+++ b/src/node/tcp-socket-factory.h Fri May 30 10:36:02 2008 -0700
@@ -27,6 +27,8 @@
class Socket;
/**
+ * \ingroup socket
+ *
* \brief API to create TCP socket instances
*
* This abstract class defines the API for TCP sockets.
--- a/src/node/tcp-socket.h Thu May 29 23:24:10 2008 -0700
+++ b/src/node/tcp-socket.h Fri May 30 10:36:02 2008 -0700
@@ -36,6 +36,8 @@
class Packet;
/**
+ * \ingroup socket
+ *
* \brief (abstract) base class of all TcpSockets
*
* This class exists solely for hosting TcpSocket attributes that can
--- a/src/node/udp-socket-factory.h Thu May 29 23:24:10 2008 -0700
+++ b/src/node/udp-socket-factory.h Fri May 30 10:36:02 2008 -0700
@@ -27,6 +27,8 @@
class Socket;
/**
+ * \ingroup socket
+ *
* \brief API to create UDP socket instances
*
* This abstract class defines the API for UDP socket factory.
--- a/src/node/udp-socket.h Thu May 29 23:24:10 2008 -0700
+++ b/src/node/udp-socket.h Fri May 30 10:36:02 2008 -0700
@@ -35,6 +35,8 @@
class Packet;
/**
+ * \ingroup socket
+ *
* \brief (abstract) base class of all UdpSockets
*
* This class exists solely for hosting UdpSocket attributes that can