diff --git a/src/core/model/assert.h b/src/core/model/assert.h index cb004f4ff..22c25d818 100644 --- a/src/core/model/assert.h +++ b/src/core/model/assert.h @@ -21,6 +21,12 @@ #ifndef NS_ASSERT_H #define NS_ASSERT_H +/** + * \file + * \ingroup assert + * Definition of assertion macros NS_ASSERT() and NS_ASSERT_MSG(). + */ + /** * \ingroup debugging * \defgroup assert Assertions diff --git a/src/core/model/breakpoint.cc b/src/core/model/breakpoint.cc index 93e91d76f..6f9cd21b6 100644 --- a/src/core/model/breakpoint.cc +++ b/src/core/model/breakpoint.cc @@ -28,6 +28,12 @@ namespace ns3 { +/** + * \file + * \ingroup breakpoint + * ns3::BreakpointFallback function implementation. + */ + NS_LOG_COMPONENT_DEFINE ("Breakpoint"); #if defined (HAVE_SIGNAL_H) && defined (SIGTRAP) diff --git a/src/core/model/breakpoint.h b/src/core/model/breakpoint.h index 79361a4ca..f48f1fde4 100644 --- a/src/core/model/breakpoint.h +++ b/src/core/model/breakpoint.h @@ -21,6 +21,13 @@ #ifndef BREAKPOINT_H #define BREAKPOINT_H +/** + * \file + * \ingroup breakpoint + * Definition of NS_BREAKPOINT() macro and ns3::BreakpointFallback + * function declaration. + */ + namespace ns3 { /* Hacker macro to place breakpoints for selected machines. diff --git a/src/core/model/cairo-wideint-private.h b/src/core/model/cairo-wideint-private.h index 7f9263205..6610e6008 100644 --- a/src/core/model/cairo-wideint-private.h +++ b/src/core/model/cairo-wideint-private.h @@ -32,6 +32,12 @@ #ifndef CAIRO_WIDEINT_H #define CAIRO_WIDEINT_H +/** + * \file + * \ingroup highprec + * Declaration of the cairo_x functions which implement high precision arithmetic. + */ + // Adapt to ns-3 environment #include "ns3/core-config.h" #define cairo_private diff --git a/src/core/model/cairo-wideint.c b/src/core/model/cairo-wideint.c index 2e9d66467..8082d3db2 100644 --- a/src/core/model/cairo-wideint.c +++ b/src/core/model/cairo-wideint.c @@ -30,6 +30,12 @@ #include "cairo-wideint-private.h" +/** + * \file + * \ingroup highprec + * Implementation of the cairo_x functions which implement high precision arithmetic. + */ + #if HAVE_UINT64_T const char * cairo_impl64 = "uint64_t"; diff --git a/src/core/model/calendar-scheduler.cc b/src/core/model/calendar-scheduler.cc index c184e302e..49ab4e08e 100644 --- a/src/core/model/calendar-scheduler.cc +++ b/src/core/model/calendar-scheduler.cc @@ -26,6 +26,12 @@ #include "assert.h" #include "log.h" +/** + * \file + * \ingroup scheduler + * Implementation of ns3::CalendarScheduler class. + */ + namespace ns3 { NS_LOG_COMPONENT_DEFINE ("CalendarScheduler"); diff --git a/src/core/model/calendar-scheduler.h b/src/core/model/calendar-scheduler.h index 705d7b97a..c08c0df35 100644 --- a/src/core/model/calendar-scheduler.h +++ b/src/core/model/calendar-scheduler.h @@ -25,6 +25,12 @@ #include #include +/** + * \file + * \ingroup scheduler + * Declaration of ns3::CalendarScheduler class. + */ + namespace ns3 { class EventImpl; diff --git a/src/core/model/callback.h b/src/core/model/callback.h index 514f57cca..041acd10e 100644 --- a/src/core/model/callback.h +++ b/src/core/model/callback.h @@ -30,6 +30,12 @@ #include "simple-ref-count.h" #include +/** + * \file + * \ingroup callback + * Declaration of the various callback functions. + */ + namespace ns3 { // Define the doxygen subgroups all at once, diff --git a/src/core/model/config.cc b/src/core/model/config.cc index f98b8b015..b521a7dc6 100644 --- a/src/core/model/config.cc +++ b/src/core/model/config.cc @@ -28,6 +28,12 @@ #include +/** + * \file + * \ingroup config + * Imlementation of the various ns3::Config functions and classes. + */ + namespace ns3 { NS_LOG_COMPONENT_DEFINE ("Config"); diff --git a/src/core/model/default-simulator-impl.cc b/src/core/model/default-simulator-impl.cc index dd5b4c6cb..566758c68 100644 --- a/src/core/model/default-simulator-impl.cc +++ b/src/core/model/default-simulator-impl.cc @@ -31,6 +31,12 @@ #include +/** + * \file + * \ingroup simulator + * Implementation of class ns3::DefaultSimulatorImpl. + */ + namespace ns3 { // Note: Logging in this file is largely avoided due to the diff --git a/src/core/model/default-simulator-impl.h b/src/core/model/default-simulator-impl.h index a820bc284..abcd354d1 100644 --- a/src/core/model/default-simulator-impl.h +++ b/src/core/model/default-simulator-impl.h @@ -31,6 +31,12 @@ #include +/** + * \file + * \ingroup simulator + * Declaration of class ns3::DefaultSimulatorImpl. + */ + namespace ns3 { /** diff --git a/src/core/model/empty.h b/src/core/model/empty.h index 4fddba471..992ead588 100644 --- a/src/core/model/empty.h +++ b/src/core/model/empty.h @@ -20,6 +20,12 @@ #ifndef EMPTY_H #define EMPTY_H +/** + * \file + * \ingroup callback + * Definition of class ns3::empty, used by callbacks. + */ + namespace ns3 { /** * \brief make Callback use a separate empty type diff --git a/src/core/model/global-value.cc b/src/core/model/global-value.cc index 4bd97ea38..7142a858b 100644 --- a/src/core/model/global-value.cc +++ b/src/core/model/global-value.cc @@ -29,6 +29,12 @@ #include #endif +/** + * \file + * \ingroup core + * ns3::GlobalValue implementation. + */ + namespace ns3 { NS_LOG_COMPONENT_DEFINE ("GlobalValue"); diff --git a/src/core/model/global-value.h b/src/core/model/global-value.h index 11386586a..1fd933e1f 100644 --- a/src/core/model/global-value.h +++ b/src/core/model/global-value.h @@ -25,6 +25,12 @@ #include "ptr.h" #include "attribute.h" +/** + * \file + * \ingroup core + * ns3::GlobalValue declaration. + */ + class GlobalValueTestCase; namespace ns3 { diff --git a/src/core/model/heap-scheduler.cc b/src/core/model/heap-scheduler.cc index eb1783480..9f37fc18b 100644 --- a/src/core/model/heap-scheduler.cc +++ b/src/core/model/heap-scheduler.cc @@ -25,6 +25,12 @@ #include "assert.h" #include "log.h" +/** + * \file + * \ingroup scheduler + * Implementation of ns3::HeapScheduler class. + */ + namespace ns3 { NS_LOG_COMPONENT_DEFINE ("HeapScheduler"); diff --git a/src/core/model/heap-scheduler.h b/src/core/model/heap-scheduler.h index 6c3b62bf4..c7f07d847 100644 --- a/src/core/model/heap-scheduler.h +++ b/src/core/model/heap-scheduler.h @@ -25,6 +25,12 @@ #include #include +/** + * \file + * \ingroup scheduler + * Declaration of ns3::HeapScheduler class. + */ + namespace ns3 { /** diff --git a/src/core/model/int64x64-128.cc b/src/core/model/int64x64-128.cc index f13b6a1ad..d2b7ca676 100644 --- a/src/core/model/int64x64-128.cc +++ b/src/core/model/int64x64-128.cc @@ -22,6 +22,12 @@ #include "assert.h" #include "log.h" +/** + * \file + * \ingroup highprec + * Implementation of the ns3::int64x64_t type using a native int128_t type.. + */ + namespace ns3 { // Note: Logging in this file is largely avoided due to the diff --git a/src/core/model/int64x64-128.h b/src/core/model/int64x64-128.h index aa2a24573..cc7146d5f 100644 --- a/src/core/model/int64x64-128.h +++ b/src/core/model/int64x64-128.h @@ -30,6 +30,12 @@ typedef __uint128_t uint128_t; typedef __int128_t int128_t; #endif +/** + * \file + * \ingroup highprec + * Declaration of the ns3::int64x64_t type using a native int128_t type.. + */ + namespace ns3 { /** diff --git a/src/core/model/int64x64-cairo.cc b/src/core/model/int64x64-cairo.cc index a90f60e36..b7ee7e28b 100644 --- a/src/core/model/int64x64-cairo.cc +++ b/src/core/model/int64x64-cairo.cc @@ -30,6 +30,12 @@ extern "C" { #include "cairo-wideint.c" } +/** + * \file + * \ingroup highprec + * Implementation of the ns3::int64x64_t type using the Cairo implementation. + */ + namespace ns3 { // Note: Logging in this file is largely avoided due to the diff --git a/src/core/model/int64x64-cairo.h b/src/core/model/int64x64-cairo.h index 40b1099a1..776da8047 100644 --- a/src/core/model/int64x64-cairo.h +++ b/src/core/model/int64x64-cairo.h @@ -25,6 +25,11 @@ #include "cairo-wideint-private.h" +/** + * \file + * \ingroup highprec + * Declaration of the ns3::int64x64_t type using the Cairo implementation. + */ namespace ns3 { diff --git a/src/core/model/int64x64-double.h b/src/core/model/int64x64-double.h index 2290da2bf..412fb7d47 100644 --- a/src/core/model/int64x64-double.h +++ b/src/core/model/int64x64-double.h @@ -25,6 +25,12 @@ #include // pow #include // pair +/** + * \file + * \ingroup highprec + * Declaration and implementation of the ns3::int64x64_t type + * using the double type. + */ namespace ns3 { diff --git a/src/core/model/int64x64.cc b/src/core/model/int64x64.cc index d86f795ee..782b3d5e1 100644 --- a/src/core/model/int64x64.cc +++ b/src/core/model/int64x64.cc @@ -25,6 +25,12 @@ #include "assert.h" #include "log.h" +/** + * \file + * \ingroup highprec + * Implementation of the streaming input and output operators for + * the ns3::int64x64_t type. + */ namespace ns3 { diff --git a/src/core/model/int64x64.h b/src/core/model/int64x64.h index 862b7f053..93d3acda5 100644 --- a/src/core/model/int64x64.h +++ b/src/core/model/int64x64.h @@ -36,6 +36,12 @@ #include +/** + * \file + * \ingroup highprec + * Declaration of the ns3::int64x64_t type and associated operators. + */ + namespace ns3 { /** diff --git a/src/core/model/list-scheduler.cc b/src/core/model/list-scheduler.cc index 6a93c37a7..53467febd 100644 --- a/src/core/model/list-scheduler.cc +++ b/src/core/model/list-scheduler.cc @@ -25,6 +25,12 @@ #include #include "assert.h" +/** + * \file + * \ingroup scheduler + * Implementation of ns3::ListScheduler class. + */ + namespace ns3 { NS_LOG_COMPONENT_DEFINE ("ListScheduler"); diff --git a/src/core/model/list-scheduler.h b/src/core/model/list-scheduler.h index 417dce67a..0cf4425cf 100644 --- a/src/core/model/list-scheduler.h +++ b/src/core/model/list-scheduler.h @@ -26,6 +26,12 @@ #include #include +/** + * \file + * \ingroup scheduler + * Declaration of ns3::ListScheduler class. + */ + namespace ns3 { class EventImpl; diff --git a/src/core/model/log-macros-enabled.h b/src/core/model/log-macros-enabled.h index e7f5aa907..82967e84e 100644 --- a/src/core/model/log-macros-enabled.h +++ b/src/core/model/log-macros-enabled.h @@ -21,6 +21,12 @@ #ifndef NS3_LOG_MACROS_ENABLED_H #define NS3_LOG_MACROS_ENABLED_H +/** + * \file + * \ingroup logging + * Definition of logging macros. + */ + #ifdef NS3_LOG_ENABLE diff --git a/src/core/model/map-scheduler.cc b/src/core/model/map-scheduler.cc index d8ba0fcf8..c2d32bf5e 100644 --- a/src/core/model/map-scheduler.cc +++ b/src/core/model/map-scheduler.cc @@ -25,6 +25,12 @@ #include "log.h" #include +/** + * \file + * \ingroup scheduler + * Implementation of ns3::MapScheduler class. + */ + namespace ns3 { NS_LOG_COMPONENT_DEFINE ("MapScheduler"); diff --git a/src/core/model/map-scheduler.h b/src/core/model/map-scheduler.h index 3687874b7..145478d23 100644 --- a/src/core/model/map-scheduler.h +++ b/src/core/model/map-scheduler.h @@ -26,6 +26,12 @@ #include #include +/** + * \file + * \ingroup scheduler + * Declaration of ns3::MapScheduler class. + */ + namespace ns3 { /** diff --git a/src/core/model/math.h b/src/core/model/math.h index 355e7b288..da19190a6 100644 --- a/src/core/model/math.h +++ b/src/core/model/math.h @@ -24,6 +24,12 @@ #ifndef MATH_H #define MATH_H +/** + * \file + * \ingroup core + * Custom version of log2() to deal with \bugid{1467}. + */ + #include #ifdef __FreeBSD__ diff --git a/src/core/model/names.cc b/src/core/model/names.cc index 306141a6f..53cfdac7e 100644 --- a/src/core/model/names.cc +++ b/src/core/model/names.cc @@ -23,6 +23,13 @@ #include "abort.h" #include "names.h" +/** + * \file + * \ingroup config + * Implementation of class ns3::Names, and declaration of classes + * ns3::NamesNode and ns3::NamePriv. + */ + namespace ns3 { NS_LOG_COMPONENT_DEFINE ("Names"); diff --git a/src/core/model/names.h b/src/core/model/names.h index f2e665370..93c2c8924 100644 --- a/src/core/model/names.h +++ b/src/core/model/names.h @@ -22,6 +22,12 @@ #include "ptr.h" #include "object.h" +/** + * \file + * \ingroup config + * Declaration of class ns3::Names. + */ + namespace ns3 { /** diff --git a/src/core/model/nstime.h b/src/core/model/nstime.h index 1f53235c1..9c85d1885 100644 --- a/src/core/model/nstime.h +++ b/src/core/model/nstime.h @@ -31,6 +31,13 @@ #include #include +/** + * \file + * \ingroup time + * Declaration of classes ns3::Time and ns3::TimeWithUnit, + * and the TimeValue implementation classes. + */ + namespace ns3 { class TimeWithUnit; diff --git a/src/core/model/object-factory.cc b/src/core/model/object-factory.cc index 9fae501e4..5a6ff3b43 100644 --- a/src/core/model/object-factory.cc +++ b/src/core/model/object-factory.cc @@ -21,6 +21,12 @@ #include "log.h" #include +/** + * \file + * \ingroup object + * ns3::ObjectFactory class implementation. + */ + namespace ns3 { NS_LOG_COMPONENT_DEFINE("ObjectFactory"); diff --git a/src/core/model/random-variable-stream.cc b/src/core/model/random-variable-stream.cc index e605d535b..a9589d645 100644 --- a/src/core/model/random-variable-stream.cc +++ b/src/core/model/random-variable-stream.cc @@ -36,6 +36,12 @@ #include #include +/** + * \file + * \ingroup randomvariable + * Implementation of ns3::RandomVariableStream and derivatives. + */ + namespace ns3 { NS_LOG_COMPONENT_DEFINE ("RandomVariableStream"); diff --git a/src/core/model/ref-count-base.cc b/src/core/model/ref-count-base.cc index 24ec0636b..ccde7ba4b 100644 --- a/src/core/model/ref-count-base.cc +++ b/src/core/model/ref-count-base.cc @@ -24,6 +24,12 @@ #include "ref-count-base.h" #include "log.h" +/** + * \file + * \ingroup ptr + * (Deprecated) ns3::RefCountBase implementation. + */ + namespace ns3 { NS_LOG_COMPONENT_DEFINE ("RefCountBase"); diff --git a/src/core/model/ref-count-base.h b/src/core/model/ref-count-base.h index a3d0b929e..22d01c9b2 100644 --- a/src/core/model/ref-count-base.h +++ b/src/core/model/ref-count-base.h @@ -25,6 +25,12 @@ #include "simple-ref-count.h" +/** + * \file + * \ingroup ptr + * (Deprecated) ns3::RefCountBase declaration. + */ + namespace ns3 { /** diff --git a/src/core/model/rng-seed-manager.cc b/src/core/model/rng-seed-manager.cc index 047bf7ec4..b35c20e37 100644 --- a/src/core/model/rng-seed-manager.cc +++ b/src/core/model/rng-seed-manager.cc @@ -24,6 +24,12 @@ #include "config.h" #include "log.h" +/** + * \file + * \ingroup randomvariable + * ns3::RngSeedManager implementation. + */ + namespace ns3 { NS_LOG_COMPONENT_DEFINE ("RngSeedManager"); diff --git a/src/core/model/simulator-impl.cc b/src/core/model/simulator-impl.cc index 09eae6817..eb20ba6a8 100644 --- a/src/core/model/simulator-impl.cc +++ b/src/core/model/simulator-impl.cc @@ -20,6 +20,12 @@ #include "simulator-impl.h" #include "log.h" +/** + * \file + * \ingroup simulator + * Implementation of class ns3::SimulatorImpl. + */ + namespace ns3 { NS_LOG_COMPONENT_DEFINE ("SimulatorImpl"); diff --git a/src/core/model/simulator-impl.h b/src/core/model/simulator-impl.h index 8ce86d3cd..53157a4a1 100644 --- a/src/core/model/simulator-impl.h +++ b/src/core/model/simulator-impl.h @@ -28,6 +28,12 @@ #include "object-factory.h" #include "ptr.h" +/** + * \file + * \ingroup simulator + * Declaration of class ns3::SimulatorImpl. + */ + namespace ns3 { class Scheduler; diff --git a/src/core/model/test.cc b/src/core/model/test.cc index cfd3bd9d9..f13ac98d9 100644 --- a/src/core/model/test.cc +++ b/src/core/model/test.cc @@ -28,6 +28,12 @@ #include +/** + * \file + * \ingroup testing + * Implementation of the testing classes and functions + */ + namespace ns3 { NS_LOG_COMPONENT_DEFINE ("Test"); diff --git a/src/core/model/test.h b/src/core/model/test.h index ca02ef6b9..08af6b9e0 100644 --- a/src/core/model/test.h +++ b/src/core/model/test.h @@ -30,6 +30,12 @@ #include "system-wall-clock-ms.h" +/** + * \file + * \ingroup testing + * Definition of the testing macros and declaration of the testing classes. + */ + /** * \ingroup core * \defgroup testing Testing diff --git a/src/core/model/time.cc b/src/core/model/time.cc index 50c9fb40d..026283767 100644 --- a/src/core/model/time.cc +++ b/src/core/model/time.cc @@ -27,6 +27,13 @@ #include // showpos #include +/** + * \file + * \ingroup time + * Implementation of classes ns3::Time and ns3::TimeWithUnit, + * and the TimeValue implementation classes. + */ + namespace ns3 { NS_LOG_COMPONENT_DEFINE_MASK ("Time", ns3::LOG_PREFIX_TIME); diff --git a/src/core/model/type-id.cc b/src/core/model/type-id.cc index cc1c82f94..31d4a999f 100644 --- a/src/core/model/type-id.cc +++ b/src/core/model/type-id.cc @@ -28,6 +28,13 @@ #include #include +/** + * \file + * \ingroup object + * ns3::TypeId and ns3::IidManager implementations. + */ + + /********************************************************************* * Helper code *********************************************************************/ diff --git a/src/core/model/type-id.h b/src/core/model/type-id.h index ad9e75390..57de9304b 100644 --- a/src/core/model/type-id.h +++ b/src/core/model/type-id.h @@ -30,6 +30,12 @@ #include #include +/** + * \file + * \ingroup object + * ns3::TypeId declaration; inline and template implementations. + */ + namespace ns3 { class ObjectBase; diff --git a/src/core/model/type-traits.h b/src/core/model/type-traits.h index 1cba616f2..b67892fd0 100644 --- a/src/core/model/type-traits.h +++ b/src/core/model/type-traits.h @@ -20,6 +20,12 @@ #ifndef TYPE_TRAITS_H #define TYPE_TRAITS_H +/** + * \file + * \ingroup object + * TypeTraits introspection template. + */ + /** Type trait reference values */ template struct TypeTraits