Doxygen organization

src/common/buffer.h

@@ -36,6 +36,8 @@
 namespace ns3 {
 
 /**
+ * \ingroup packet
+ *
  * \brief automatically resized byte buffer
  *
  * This represents a buffer of bytes. Its size is

src/common/chunk.h

@@ -6,6 +6,9 @@
 
 namespace ns3 {
 
+/**
+ * \ingroup packet
+ */
 class Chunk : public ObjectBase
 {
  public:

src/common/data-rate.h

@@ -31,6 +31,9 @@
 namespace ns3 {
 
 /**
+ * \ingroup common
+ * \defgroup datarate Data Rate
+ *
  * \brief Class for representing data rates
  *
  * Allows for natural and familiar use of data rates.  Allows construction

src/common/error-model.h

@@ -30,6 +30,9 @@ namespace ns3 {
 class Packet;
 
 /**
+ * \ingroup common
+ * \defgroup errormodel Error Model
+ *
  * \brief General error model that can be used to corrupt packets
  *
  * This object is used to flag packets as being lost/errored or not.

src/common/header.h

@@ -28,6 +28,8 @@
 namespace ns3 {
 
 /**
+ * \ingroup Packet
+ *
  * \brief Protocol header serialization and deserialization.
  *
  * Every Protocol header which needs to be inserted or removed

src/common/packet-metadata.h

@@ -36,6 +36,7 @@ class Trailer;
 
 /**
  * \internal
+ * \ingroup packet
  * \brief handle packet metadata about packet headers and trailers
  *
  * This class is used by the Packet class to record every operation

src/common/packet.h

@@ -96,6 +96,9 @@ private:
 };
 
 /**
+ * \ingroup common
+ * \defgroup packet Packet
+ *
  * \brief network packets
  *
  * Each network packet contains a byte buffer, a set of tags, and

src/common/pcap-writer.h

@@ -29,6 +29,8 @@ namespace ns3 {
 class Packet;
 
 /**
+ * \ingroup common
+ *
  * \brief Pcap output for Packet logger
  *
  * Log Packets to a file in pcap format which can be

src/common/tag-buffer.h

@@ -33,6 +33,8 @@
 namespace ns3 {
 
 /**
+ * \ingroup packet
+ *
  * \brief read and write tag data
  *
  * This class allows subclasses of the ns3::Tag base class

src/common/tag-list.h

@@ -29,6 +29,8 @@ namespace ns3 {
 struct TagListData;
 
 /**
+ * \ingroup packet
+ *
  * \brief keep track of the tags stored in a packet.
  *
  * This class is mostly private to the Packet implementation and users

src/common/tag.h

@@ -27,6 +27,8 @@
 namespace ns3 {
 
 /**
+ * \ingroup packet
+ *
  * \brief tag a set of bytes in a packet
  *
  * New kinds of tags can be created by subclassing this base class.

src/common/trailer.h

@@ -29,6 +29,8 @@
 namespace ns3 {
 
 /**
+ * \ingroup packet
+ *
  * \brief Protocol trailer serialization and deserialization.
  *
  * Every Protocol trailer which needs to be inserted or removed

src/core/assert.h

@@ -28,7 +28,12 @@
 
 /**
  * \ingroup core
+ * \defgroup debugging Debugging
+ */
+/**
+ * \ingroup debugging
  * \defgroup assert Assert
+ *
  * \brief assert functions and macros
  *
  * The assert macros are used to verify

src/core/attribute-accessor-helper.h

@@ -24,10 +24,16 @@
 
 namespace ns3 {
 
+/**
+ * \ingroup AttributeHelper
+ */
 template <typename V, typename T1>
 Ptr<const AttributeAccessor>
 MakeAccessorHelper (T1 a1);
 
+/**
+ * \ingroup AttributeHelper
+ */
 template <typename V, typename T1, typename T2>
 Ptr<const AttributeAccessor>
 MakeAccessorHelper (T1 a1, T2 a2);

src/core/attribute-list.h

@@ -28,6 +28,8 @@
 namespace ns3 {
 
 /**
+ * \ingroup attribute
+ *
  * \brief a container of attributes to be used during object's construction
  *        and in ns3::Object::Set.
  *

src/core/attribute.h

@@ -33,6 +33,15 @@ class Attribute;
 class ObjectBase;
 
 /**
+ *
+ * \ingroup core
+ * \defgroup attribute Attribute
+ */
+
+/**
+ *
+ * \ingroup attribute
+ *
  * \brief Hold a value for an Attribute.
  *
  * Instances of this class should always be wrapped into an Attribute object.
@@ -78,6 +87,8 @@ public:
 /**
  * \brief allow setting and getting the value of an attribute.
  *
+ * \ingroup attribute
+ *
  * The goal of this class is to hide from the user how an attribute
  * is actually set or get to or from a class instance. Implementations
  * of this base class are usually provided through the MakeAccessorHelper
@@ -124,6 +135,8 @@ public:
 /**
  * \brief Represent the type of an attribute
  *
+ * \ingroup attribute
+ *
  * Each type of attribute has an associated unique AttributeChecker
  * subclass. The type of the subclass can be safely used by users
  * to infer the type of the associated attribute. i.e., we expect
@@ -180,6 +193,11 @@ public:
 
 };
 
+/**
+ * \brief A class for an empty attribute value
+ *
+ * \ingroup attribute
+ */
 class EmptyAttributeValue : public AttributeValue
 {
 public:

src/core/boolean.h

@@ -26,6 +26,8 @@
 namespace ns3 {
 
 /**
+ * \ingroup attribute
+ *
  * \brief Hold a bool native type
  *
  * \anchor bool

src/core/double.h

@@ -27,6 +27,8 @@
 namespace ns3 {
 
 /**
+ * \ingroup attribute 
+ *
  * \class ns3::DoubleValue
  * \brief Hold an floating point type
  *

src/core/empty.h

@@ -2,6 +2,9 @@
 #define EMPTY_H
 
 namespace ns3 {
+/**
+ * \brief make Callback use a separate empty type
+ */
 class empty {};
 }
 

src/core/enum.h

@@ -27,6 +27,8 @@
 namespace ns3 {
 
 /**
+ * \ingroup attribute
+ *
  * \brief hold variables of type 'enum'
  *
  * This class can be used to hold variables of any kind

src/core/fatal-error.h

@@ -24,8 +24,7 @@
 #include <iostream>
 
 /**
- * \ingroup core
- * \defgroup error Error
+ * \ingroup debugging
  * \brief fatal error handling
  *
  * \param msg message to output when this macro is hit.

src/core/global-value.h

@@ -29,6 +29,8 @@
 namespace ns3 {
 
 /**
+ * \ingroup Core
+ *
  * \brief hold a so-called 'global value'.
  *
  * Instances of this class are expected to be allocated as static 

src/core/integer.h

@@ -27,6 +27,7 @@
 namespace ns3 {
 
 /**
+ * \ingroup attribute
  * \class ns3::IntegerValue
  * \brief Hold a signed integer type
  *

src/core/log.h

@@ -28,7 +28,7 @@
 
 
 /**
- * \ingroup core
+ * \ingroup debugging
  * \defgroup logging Logging
  * \brief Logging functions and macros
  *

src/core/object-base.h

@@ -42,6 +42,8 @@ namespace ns3 {
 class AttributeList;
 
 /**
+ * \ingroup object
+ *
  * \brief implement the ns-3 type and attribute system
  *
  * Every class which wants to integrate in the ns-3 type and attribute

src/core/object-factory.h

@@ -29,6 +29,8 @@ namespace ns3 {
 class AttributeValue;
 
 /**
+ * \ingroup object
+ *
  * \brief instantiate subclasses of ns3::Object.
  *
  * This class can also hold a set of attributes to set

src/core/object-vector.h

@@ -9,6 +9,8 @@
 namespace ns3 {
 
 /**
+ * \ingroup object
+ * 
  * \brief contain a vector of ns3::Object pointers.
  *
  * This class it used to get attribute access to an array of

src/core/object.h

@@ -39,6 +39,11 @@ class AttributeList;
 class TraceSourceAccessor;
 
 /**
+ * \ingroup core
+ * \defgroup object Object
+ */
+/**
+ * \ingroup object
  * \brief a base class which provides memory management and object aggregation
  *
  */

src/core/pointer.h

@@ -26,6 +26,8 @@
 namespace ns3 {
 
 /**
+ * \ingroup attribute
+ *
  * \brief hold objects of type Ptr<T>
  */
 class PointerValue : public AttributeValue

src/core/ptr.h

@@ -28,6 +28,12 @@
 namespace ns3 {
 
 /**
+ * \ingroup core
+ * \defgroup ptr Smart Pointer
+ */
+/**
+ * \ingroup ptr
+ *
  * \brief smart pointer class similar to boost::intrusive_ptr
  *
  * This smart-pointer class assumes that the underlying

src/core/string.h

@@ -7,6 +7,8 @@
 namespace ns3 {
 
 /**
+ * \ingroup attribute
+ *
  * \class ns3::StringValue
  * \brief hold variables of type string
  *

src/core/test.h

@@ -33,6 +33,12 @@ namespace ns3 {
 class TestManager;
 
 /**
+ * \ingroup core
+ * \defgroup test Test
+ */
+/**
+ * \ingroup test
+ *
  * \brief base class for new regressions tests
  *
  * To add a new regression test, you need to:
@@ -65,6 +71,8 @@ protected:
 };
 
 /**
+ * \ingroup test
+ *
  * \brief gather and run all regression tests
  */
 class TestManager {

src/core/trace-source-accessor.h

@@ -29,6 +29,8 @@ namespace ns3 {
 class ObjectBase;
 
 /**
+ * \ingroup tracing
+ *
  * \brief control access to objects' trace sources
  *
  * This class abstracts the kind of trace source to which we want to connect

src/core/traced-value.h

@@ -32,6 +32,13 @@
 namespace ns3 {
 
 /**
+ * \ingroup core
+ * \defgroup tracing Tracing
+ */
+
+/**
+ * \ingroup tracing
+ *
  * \brief trace classes with value semantics
  *
  * If you want to trace the change of value of a class or

src/core/uinteger.h

@@ -27,6 +27,8 @@
 namespace ns3 {
 
 /**
+ * \ingroup attribute
+ *
  * \class ns3::UintegerValue
  * \brief Hold an unsigned integer type
  *

src/simulator/event-impl.h

@@ -24,6 +24,9 @@
 
 namespace ns3 {
 
+/**
+ * \ingroup simulator
+ */
 class EventImpl
 {
 public:

src/simulator/heap-scheduler.h

@@ -29,6 +29,9 @@ namespace ns3 {
 
 class EventHolder;
 
+/**
+ * \ingroup scheduler
+ */
 class HeapScheduler : public Scheduler {
 public:
   HeapScheduler ();

src/simulator/list-scheduler.h

@@ -31,6 +31,9 @@ namespace ns3 {
 
 class EventImpl;
 
+/**
+ * \ingroup scheduler
+ */
 class ListScheduler : public Scheduler {
  public:
   ListScheduler ();

src/simulator/map-scheduler.h

@@ -30,6 +30,9 @@ namespace ns3 {
 
 class EventImpl;
 
+/**
+ * \ingroup scheduler
+ */
 class MapScheduler : public Scheduler {
 public:
   MapScheduler ();

src/simulator/nstime.h

@@ -60,6 +60,9 @@ precision_t Get (void);
 
 
 /**
+ * \ingroup simulator
+ * \defgroup time Time
+ *
  * \brief keep track of time unit.
  *
  * This template class is used to keep track of the value 

src/simulator/scheduler.h

@@ -28,6 +28,9 @@
 namespace ns3 {
 
 /**
+ * \ingroup simulator
+ * \defgroup scheduler Scheduler
+ *
  * \brief Maintain the event list
  *
  * This base class specifies the interface used to maintain the 

src/simulator/simulator.h

@@ -35,6 +35,8 @@ class SimulatorPrivate;
 class SchedulerFactory;
 
 /**
+ * \ingroup simulator
+ *
  * \brief Control the scheduling of simulation events. 
  *
  * The internal simulation clock is maintained

src/simulator/timer.h

@@ -30,6 +30,8 @@ namespace ns3 {
 class TimerImpl;
 
 /**
+ * \ingroup simulator
+ *
  * \brief a simple Timer class
  *
  * A timer is used to hold together a delay, a function to invoke

src/simulator/watchdog.h

@@ -27,6 +27,9 @@ namespace ns3 {
 
 class TimerImpl;
 
+/**
+ * \ingroup simulator
+ */
 class Watchdog 
 {
 public: