From dfb9b7360a42e1794e745e3e1766ffc9d7d0218a Mon Sep 17 00:00:00 2001 From: Tom Henderson Date: Thu, 29 May 2008 23:24:10 -0700 Subject: [PATCH] Doxygen organization --- src/common/buffer.h | 2 ++ src/common/chunk.h | 3 +++ src/common/data-rate.h | 3 +++ src/common/error-model.h | 3 +++ src/common/header.h | 2 ++ src/common/packet-metadata.h | 1 + src/common/packet.h | 3 +++ src/common/pcap-writer.h | 2 ++ src/common/tag-buffer.h | 2 ++ src/common/tag-list.h | 2 ++ src/common/tag.h | 2 ++ src/common/trailer.h | 2 ++ src/core/assert.h | 5 +++++ src/core/attribute-accessor-helper.h | 6 ++++++ src/core/attribute-list.h | 2 ++ src/core/attribute.h | 18 ++++++++++++++++++ src/core/boolean.h | 2 ++ src/core/double.h | 2 ++ src/core/empty.h | 3 +++ src/core/enum.h | 2 ++ src/core/fatal-error.h | 3 +-- src/core/global-value.h | 2 ++ src/core/integer.h | 1 + src/core/log.h | 2 +- src/core/object-base.h | 2 ++ src/core/object-factory.h | 2 ++ src/core/object-vector.h | 2 ++ src/core/object.h | 5 +++++ src/core/pointer.h | 2 ++ src/core/ptr.h | 6 ++++++ src/core/string.h | 2 ++ src/core/test.h | 8 ++++++++ src/core/trace-source-accessor.h | 2 ++ src/core/traced-value.h | 7 +++++++ src/core/uinteger.h | 2 ++ src/simulator/event-impl.h | 3 +++ src/simulator/heap-scheduler.h | 3 +++ src/simulator/list-scheduler.h | 3 +++ src/simulator/map-scheduler.h | 3 +++ src/simulator/nstime.h | 3 +++ src/simulator/scheduler.h | 3 +++ src/simulator/simulator.h | 2 ++ src/simulator/timer.h | 2 ++ src/simulator/watchdog.h | 3 +++ 44 files changed, 137 insertions(+), 3 deletions(-) diff --git a/src/common/buffer.h b/src/common/buffer.h index 75f93f780..65081f474 100644 --- a/src/common/buffer.h +++ b/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 diff --git a/src/common/chunk.h b/src/common/chunk.h index f2a6a9404..44bbe4545 100644 --- a/src/common/chunk.h +++ b/src/common/chunk.h @@ -6,6 +6,9 @@ namespace ns3 { +/** + * \ingroup packet + */ class Chunk : public ObjectBase { public: diff --git a/src/common/data-rate.h b/src/common/data-rate.h index 3ebdbeaab..388c30173 100644 --- a/src/common/data-rate.h +++ b/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 diff --git a/src/common/error-model.h b/src/common/error-model.h index 5cd050548..309d0e4be 100644 --- a/src/common/error-model.h +++ b/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. diff --git a/src/common/header.h b/src/common/header.h index 42e0bc9aa..cb44d3dae 100644 --- a/src/common/header.h +++ b/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 diff --git a/src/common/packet-metadata.h b/src/common/packet-metadata.h index 37285e960..b5a2096c0 100644 --- a/src/common/packet-metadata.h +++ b/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 diff --git a/src/common/packet.h b/src/common/packet.h index e79d82125..2e5d9ef49 100644 --- a/src/common/packet.h +++ b/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 diff --git a/src/common/pcap-writer.h b/src/common/pcap-writer.h index 2a34a5b63..52450a117 100644 --- a/src/common/pcap-writer.h +++ b/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 diff --git a/src/common/tag-buffer.h b/src/common/tag-buffer.h index 2e5836a21..6ef0e94cd 100644 --- a/src/common/tag-buffer.h +++ b/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 diff --git a/src/common/tag-list.h b/src/common/tag-list.h index 10cf3ff60..acfdf7558 100644 --- a/src/common/tag-list.h +++ b/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 diff --git a/src/common/tag.h b/src/common/tag.h index c4191864d..8454ae394 100644 --- a/src/common/tag.h +++ b/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. diff --git a/src/common/trailer.h b/src/common/trailer.h index e3771605b..70eb25130 100644 --- a/src/common/trailer.h +++ b/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 diff --git a/src/core/assert.h b/src/core/assert.h index 54c460549..3dadf537c 100644 --- a/src/core/assert.h +++ b/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 diff --git a/src/core/attribute-accessor-helper.h b/src/core/attribute-accessor-helper.h index 1e0223b09..f5e329dd9 100644 --- a/src/core/attribute-accessor-helper.h +++ b/src/core/attribute-accessor-helper.h @@ -24,10 +24,16 @@ namespace ns3 { +/** + * \ingroup AttributeHelper + */ template Ptr MakeAccessorHelper (T1 a1); +/** + * \ingroup AttributeHelper + */ template Ptr MakeAccessorHelper (T1 a1, T2 a2); diff --git a/src/core/attribute-list.h b/src/core/attribute-list.h index 922a5dbaf..36bda6735 100644 --- a/src/core/attribute-list.h +++ b/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. * diff --git a/src/core/attribute.h b/src/core/attribute.h index 7061f1a70..aa16c8634 100644 --- a/src/core/attribute.h +++ b/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: diff --git a/src/core/boolean.h b/src/core/boolean.h index d4186b391..eb15d9506 100644 --- a/src/core/boolean.h +++ b/src/core/boolean.h @@ -26,6 +26,8 @@ namespace ns3 { /** + * \ingroup attribute + * * \brief Hold a bool native type * * \anchor bool diff --git a/src/core/double.h b/src/core/double.h index 60de64150..1ed54ecdd 100644 --- a/src/core/double.h +++ b/src/core/double.h @@ -27,6 +27,8 @@ namespace ns3 { /** + * \ingroup attribute + * * \class ns3::DoubleValue * \brief Hold an floating point type * diff --git a/src/core/empty.h b/src/core/empty.h index 6b89b9cdb..bf3a24248 100644 --- a/src/core/empty.h +++ b/src/core/empty.h @@ -2,6 +2,9 @@ #define EMPTY_H namespace ns3 { +/** + * \brief make Callback use a separate empty type + */ class empty {}; } diff --git a/src/core/enum.h b/src/core/enum.h index 4cea3134a..d9eeb521f 100644 --- a/src/core/enum.h +++ b/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 diff --git a/src/core/fatal-error.h b/src/core/fatal-error.h index 9b72b77f0..8e896cf2f 100644 --- a/src/core/fatal-error.h +++ b/src/core/fatal-error.h @@ -24,8 +24,7 @@ #include /** - * \ingroup core - * \defgroup error Error + * \ingroup debugging * \brief fatal error handling * * \param msg message to output when this macro is hit. diff --git a/src/core/global-value.h b/src/core/global-value.h index db1a82854..e8d1a3232 100644 --- a/src/core/global-value.h +++ b/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 diff --git a/src/core/integer.h b/src/core/integer.h index ea7a20c0e..8ac78e47d 100644 --- a/src/core/integer.h +++ b/src/core/integer.h @@ -27,6 +27,7 @@ namespace ns3 { /** + * \ingroup attribute * \class ns3::IntegerValue * \brief Hold a signed integer type * diff --git a/src/core/log.h b/src/core/log.h index 41b190370..f2565d71a 100644 --- a/src/core/log.h +++ b/src/core/log.h @@ -28,7 +28,7 @@ /** - * \ingroup core + * \ingroup debugging * \defgroup logging Logging * \brief Logging functions and macros * diff --git a/src/core/object-base.h b/src/core/object-base.h index 27dd4f735..fa8d5ed41 100644 --- a/src/core/object-base.h +++ b/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 diff --git a/src/core/object-factory.h b/src/core/object-factory.h index 01f9341ed..9ae305c08 100644 --- a/src/core/object-factory.h +++ b/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 diff --git a/src/core/object-vector.h b/src/core/object-vector.h index 5f79ae73d..edf80e9fb 100644 --- a/src/core/object-vector.h +++ b/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 diff --git a/src/core/object.h b/src/core/object.h index 00d8036ba..c136e89ae 100644 --- a/src/core/object.h +++ b/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 * */ diff --git a/src/core/pointer.h b/src/core/pointer.h index 83ddac3a2..5fcb28718 100644 --- a/src/core/pointer.h +++ b/src/core/pointer.h @@ -26,6 +26,8 @@ namespace ns3 { /** + * \ingroup attribute + * * \brief hold objects of type Ptr */ class PointerValue : public AttributeValue diff --git a/src/core/ptr.h b/src/core/ptr.h index 7aca41da4..2bcbf3c60 100644 --- a/src/core/ptr.h +++ b/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 diff --git a/src/core/string.h b/src/core/string.h index 65d21590f..8aba4b9ae 100644 --- a/src/core/string.h +++ b/src/core/string.h @@ -7,6 +7,8 @@ namespace ns3 { /** + * \ingroup attribute + * * \class ns3::StringValue * \brief hold variables of type string * diff --git a/src/core/test.h b/src/core/test.h index 1ee298686..358603a3f 100644 --- a/src/core/test.h +++ b/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 { diff --git a/src/core/trace-source-accessor.h b/src/core/trace-source-accessor.h index 48ea7ac0a..4a76aa598 100644 --- a/src/core/trace-source-accessor.h +++ b/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 diff --git a/src/core/traced-value.h b/src/core/traced-value.h index 0015e39aa..837c0536a 100644 --- a/src/core/traced-value.h +++ b/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 diff --git a/src/core/uinteger.h b/src/core/uinteger.h index f6565b309..c67709272 100644 --- a/src/core/uinteger.h +++ b/src/core/uinteger.h @@ -27,6 +27,8 @@ namespace ns3 { /** + * \ingroup attribute + * * \class ns3::UintegerValue * \brief Hold an unsigned integer type * diff --git a/src/simulator/event-impl.h b/src/simulator/event-impl.h index 526beffd5..10efba66a 100644 --- a/src/simulator/event-impl.h +++ b/src/simulator/event-impl.h @@ -24,6 +24,9 @@ namespace ns3 { +/** + * \ingroup simulator + */ class EventImpl { public: diff --git a/src/simulator/heap-scheduler.h b/src/simulator/heap-scheduler.h index 20e8165e7..3109d0f74 100644 --- a/src/simulator/heap-scheduler.h +++ b/src/simulator/heap-scheduler.h @@ -29,6 +29,9 @@ namespace ns3 { class EventHolder; +/** + * \ingroup scheduler + */ class HeapScheduler : public Scheduler { public: HeapScheduler (); diff --git a/src/simulator/list-scheduler.h b/src/simulator/list-scheduler.h index c4e70398b..0882c3809 100644 --- a/src/simulator/list-scheduler.h +++ b/src/simulator/list-scheduler.h @@ -31,6 +31,9 @@ namespace ns3 { class EventImpl; +/** + * \ingroup scheduler + */ class ListScheduler : public Scheduler { public: ListScheduler (); diff --git a/src/simulator/map-scheduler.h b/src/simulator/map-scheduler.h index cc49ecd34..f01c84a62 100644 --- a/src/simulator/map-scheduler.h +++ b/src/simulator/map-scheduler.h @@ -30,6 +30,9 @@ namespace ns3 { class EventImpl; +/** + * \ingroup scheduler + */ class MapScheduler : public Scheduler { public: MapScheduler (); diff --git a/src/simulator/nstime.h b/src/simulator/nstime.h index 8fef4231c..6b4729b2a 100644 --- a/src/simulator/nstime.h +++ b/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 diff --git a/src/simulator/scheduler.h b/src/simulator/scheduler.h index 276c36c96..14149cddb 100644 --- a/src/simulator/scheduler.h +++ b/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 diff --git a/src/simulator/simulator.h b/src/simulator/simulator.h index b1c4a9ecf..15f000cf5 100644 --- a/src/simulator/simulator.h +++ b/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 diff --git a/src/simulator/timer.h b/src/simulator/timer.h index 1b25638e8..d9da113f0 100644 --- a/src/simulator/timer.h +++ b/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 diff --git a/src/simulator/watchdog.h b/src/simulator/watchdog.h index 3bb37a9b4..2edb1cf9e 100644 --- a/src/simulator/watchdog.h +++ b/src/simulator/watchdog.h @@ -27,6 +27,9 @@ namespace ns3 { class TimerImpl; +/** + * \ingroup simulator + */ class Watchdog { public: