Doxygen files.
--- a/src/core/model/assert.h Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/assert.h Mon May 04 17:55:16 2015 -0700
@@ -22,6 +22,12 @@
#define NS_ASSERT_H
/**
+ * \file
+ * \ingroup assert
+ * Definition of assertion macros NS_ASSERT() and NS_ASSERT_MSG().
+ */
+
+/**
* \ingroup debugging
* \defgroup assert Assertions
*
--- a/src/core/model/breakpoint.cc Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/breakpoint.cc Mon May 04 17:55:16 2015 -0700
@@ -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)
--- a/src/core/model/breakpoint.h Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/breakpoint.h Mon May 04 17:55:16 2015 -0700
@@ -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.
--- a/src/core/model/cairo-wideint-private.h Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/cairo-wideint-private.h Mon May 04 17:55:16 2015 -0700
@@ -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
--- a/src/core/model/cairo-wideint.c Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/cairo-wideint.c Mon May 04 17:55:16 2015 -0700
@@ -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";
--- a/src/core/model/calendar-scheduler.cc Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/calendar-scheduler.cc Mon May 04 17:55:16 2015 -0700
@@ -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");
--- a/src/core/model/calendar-scheduler.h Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/calendar-scheduler.h Mon May 04 17:55:16 2015 -0700
@@ -25,6 +25,12 @@
#include <stdint.h>
#include <list>
+/**
+ * \file
+ * \ingroup scheduler
+ * Declaration of ns3::CalendarScheduler class.
+ */
+
namespace ns3 {
class EventImpl;
--- a/src/core/model/callback.h Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/callback.h Mon May 04 17:55:16 2015 -0700
@@ -30,6 +30,12 @@
#include "simple-ref-count.h"
#include <typeinfo>
+/**
+ * \file
+ * \ingroup callback
+ * Declaration of the various callback functions.
+ */
+
namespace ns3 {
// Define the doxygen subgroups all at once,
--- a/src/core/model/config.cc Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/config.cc Mon May 04 17:55:16 2015 -0700
@@ -28,6 +28,12 @@
#include <sstream>
+/**
+ * \file
+ * \ingroup config
+ * Imlementation of the various ns3::Config functions and classes.
+ */
+
namespace ns3 {
NS_LOG_COMPONENT_DEFINE ("Config");
--- a/src/core/model/default-simulator-impl.cc Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/default-simulator-impl.cc Mon May 04 17:55:16 2015 -0700
@@ -31,6 +31,12 @@
#include <cmath>
+/**
+ * \file
+ * \ingroup simulator
+ * Implementation of class ns3::DefaultSimulatorImpl.
+ */
+
namespace ns3 {
// Note: Logging in this file is largely avoided due to the
--- a/src/core/model/default-simulator-impl.h Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/default-simulator-impl.h Mon May 04 17:55:16 2015 -0700
@@ -31,6 +31,12 @@
#include <list>
+/**
+ * \file
+ * \ingroup simulator
+ * Declaration of class ns3::DefaultSimulatorImpl.
+ */
+
namespace ns3 {
/**
--- a/src/core/model/empty.h Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/empty.h Mon May 04 17:55:16 2015 -0700
@@ -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
--- a/src/core/model/global-value.cc Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/global-value.cc Mon May 04 17:55:16 2015 -0700
@@ -29,6 +29,12 @@
#include <cstdlib>
#endif
+/**
+ * \file
+ * \ingroup core
+ * ns3::GlobalValue implementation.
+ */
+
namespace ns3 {
NS_LOG_COMPONENT_DEFINE ("GlobalValue");
--- a/src/core/model/global-value.h Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/global-value.h Mon May 04 17:55:16 2015 -0700
@@ -25,6 +25,12 @@
#include "ptr.h"
#include "attribute.h"
+/**
+ * \file
+ * \ingroup core
+ * ns3::GlobalValue declaration.
+ */
+
class GlobalValueTestCase;
namespace ns3 {
--- a/src/core/model/heap-scheduler.cc Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/heap-scheduler.cc Mon May 04 17:55:16 2015 -0700
@@ -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");
--- a/src/core/model/heap-scheduler.h Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/heap-scheduler.h Mon May 04 17:55:16 2015 -0700
@@ -25,6 +25,12 @@
#include <stdint.h>
#include <vector>
+/**
+ * \file
+ * \ingroup scheduler
+ * Declaration of ns3::HeapScheduler class.
+ */
+
namespace ns3 {
/**
--- a/src/core/model/int64x64-128.cc Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/int64x64-128.cc Mon May 04 17:55:16 2015 -0700
@@ -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
--- a/src/core/model/int64x64-128.h Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/int64x64-128.h Mon May 04 17:55:16 2015 -0700
@@ -30,6 +30,12 @@
typedef __int128_t int128_t;
#endif
+/**
+ * \file
+ * \ingroup highprec
+ * Declaration of the ns3::int64x64_t type using a native int128_t type..
+ */
+
namespace ns3 {
/**
--- a/src/core/model/int64x64-cairo.cc Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/int64x64-cairo.cc Mon May 04 17:55:16 2015 -0700
@@ -30,6 +30,12 @@
#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
--- a/src/core/model/int64x64-cairo.h Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/int64x64-cairo.h Mon May 04 17:55:16 2015 -0700
@@ -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 {
--- a/src/core/model/int64x64-double.h Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/int64x64-double.h Mon May 04 17:55:16 2015 -0700
@@ -25,6 +25,12 @@
#include <cmath> // pow
#include <utility> // pair
+/**
+ * \file
+ * \ingroup highprec
+ * Declaration and implementation of the ns3::int64x64_t type
+ * using the double type.
+ */
namespace ns3 {
--- a/src/core/model/int64x64.cc Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/int64x64.cc Mon May 04 17:55:16 2015 -0700
@@ -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 {
--- a/src/core/model/int64x64.h Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/int64x64.h Mon May 04 17:55:16 2015 -0700
@@ -36,6 +36,12 @@
#include <iostream>
+/**
+ * \file
+ * \ingroup highprec
+ * Declaration of the ns3::int64x64_t type and associated operators.
+ */
+
namespace ns3 {
/**
--- a/src/core/model/list-scheduler.cc Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/list-scheduler.cc Mon May 04 17:55:16 2015 -0700
@@ -25,6 +25,12 @@
#include <string>
#include "assert.h"
+/**
+ * \file
+ * \ingroup scheduler
+ * Implementation of ns3::ListScheduler class.
+ */
+
namespace ns3 {
NS_LOG_COMPONENT_DEFINE ("ListScheduler");
--- a/src/core/model/list-scheduler.h Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/list-scheduler.h Mon May 04 17:55:16 2015 -0700
@@ -26,6 +26,12 @@
#include <utility>
#include <stdint.h>
+/**
+ * \file
+ * \ingroup scheduler
+ * Declaration of ns3::ListScheduler class.
+ */
+
namespace ns3 {
class EventImpl;
--- a/src/core/model/log-macros-enabled.h Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/log-macros-enabled.h Mon May 04 17:55:16 2015 -0700
@@ -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
--- a/src/core/model/map-scheduler.cc Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/map-scheduler.cc Mon May 04 17:55:16 2015 -0700
@@ -25,6 +25,12 @@
#include "log.h"
#include <string>
+/**
+ * \file
+ * \ingroup scheduler
+ * Implementation of ns3::MapScheduler class.
+ */
+
namespace ns3 {
NS_LOG_COMPONENT_DEFINE ("MapScheduler");
--- a/src/core/model/map-scheduler.h Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/map-scheduler.h Mon May 04 17:55:16 2015 -0700
@@ -26,6 +26,12 @@
#include <map>
#include <utility>
+/**
+ * \file
+ * \ingroup scheduler
+ * Declaration of ns3::MapScheduler class.
+ */
+
namespace ns3 {
/**
--- a/src/core/model/math.h Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/math.h Mon May 04 17:55:16 2015 -0700
@@ -24,6 +24,12 @@
#ifndef MATH_H
#define MATH_H
+/**
+ * \file
+ * \ingroup core
+ * Custom version of log2() to deal with \bugid{1467}.
+ */
+
#include <cmath>
#ifdef __FreeBSD__
--- a/src/core/model/names.cc Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/names.cc Mon May 04 17:55:16 2015 -0700
@@ -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");
--- a/src/core/model/names.h Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/names.h Mon May 04 17:55:16 2015 -0700
@@ -22,6 +22,12 @@
#include "ptr.h"
#include "object.h"
+/**
+ * \file
+ * \ingroup config
+ * Declaration of class ns3::Names.
+ */
+
namespace ns3 {
/**
--- a/src/core/model/nstime.h Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/nstime.h Mon May 04 17:55:16 2015 -0700
@@ -31,6 +31,13 @@
#include <ostream>
#include <set>
+/**
+ * \file
+ * \ingroup time
+ * Declaration of classes ns3::Time and ns3::TimeWithUnit,
+ * and the TimeValue implementation classes.
+ */
+
namespace ns3 {
class TimeWithUnit;
--- a/src/core/model/object-factory.cc Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/object-factory.cc Mon May 04 17:55:16 2015 -0700
@@ -21,6 +21,12 @@
#include "log.h"
#include <sstream>
+/**
+ * \file
+ * \ingroup object
+ * ns3::ObjectFactory class implementation.
+ */
+
namespace ns3 {
NS_LOG_COMPONENT_DEFINE("ObjectFactory");
--- a/src/core/model/random-variable-stream.cc Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/random-variable-stream.cc Mon May 04 17:55:16 2015 -0700
@@ -36,6 +36,12 @@
#include <cmath>
#include <iostream>
+/**
+ * \file
+ * \ingroup randomvariable
+ * Implementation of ns3::RandomVariableStream and derivatives.
+ */
+
namespace ns3 {
NS_LOG_COMPONENT_DEFINE ("RandomVariableStream");
--- a/src/core/model/ref-count-base.cc Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/ref-count-base.cc Mon May 04 17:55:16 2015 -0700
@@ -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");
--- a/src/core/model/ref-count-base.h Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/ref-count-base.h Mon May 04 17:55:16 2015 -0700
@@ -25,6 +25,12 @@
#include "simple-ref-count.h"
+/**
+ * \file
+ * \ingroup ptr
+ * (Deprecated) ns3::RefCountBase declaration.
+ */
+
namespace ns3 {
/**
--- a/src/core/model/rng-seed-manager.cc Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/rng-seed-manager.cc Mon May 04 17:55:16 2015 -0700
@@ -24,6 +24,12 @@
#include "config.h"
#include "log.h"
+/**
+ * \file
+ * \ingroup randomvariable
+ * ns3::RngSeedManager implementation.
+ */
+
namespace ns3 {
NS_LOG_COMPONENT_DEFINE ("RngSeedManager");
--- a/src/core/model/simulator-impl.cc Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/simulator-impl.cc Mon May 04 17:55:16 2015 -0700
@@ -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");
--- a/src/core/model/simulator-impl.h Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/simulator-impl.h Mon May 04 17:55:16 2015 -0700
@@ -28,6 +28,12 @@
#include "object-factory.h"
#include "ptr.h"
+/**
+ * \file
+ * \ingroup simulator
+ * Declaration of class ns3::SimulatorImpl.
+ */
+
namespace ns3 {
class Scheduler;
--- a/src/core/model/test.cc Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/test.cc Mon May 04 17:55:16 2015 -0700
@@ -28,6 +28,12 @@
#include <map>
+/**
+ * \file
+ * \ingroup testing
+ * Implementation of the testing classes and functions
+ */
+
namespace ns3 {
NS_LOG_COMPONENT_DEFINE ("Test");
--- a/src/core/model/test.h Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/test.h Mon May 04 17:55:16 2015 -0700
@@ -31,6 +31,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
* \brief Tools to define and execute unit tests.
--- a/src/core/model/time.cc Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/time.cc Mon May 04 17:55:16 2015 -0700
@@ -27,6 +27,13 @@
#include <iomanip> // showpos
#include <sstream>
+/**
+ * \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);
--- a/src/core/model/type-id.cc Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/type-id.cc Mon May 04 17:55:16 2015 -0700
@@ -28,6 +28,13 @@
#include <sstream>
#include <iomanip>
+/**
+ * \file
+ * \ingroup object
+ * ns3::TypeId and ns3::IidManager implementations.
+ */
+
+
/*********************************************************************
* Helper code
*********************************************************************/
--- a/src/core/model/type-id.h Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/type-id.h Mon May 04 17:55:16 2015 -0700
@@ -30,6 +30,12 @@
#include <string>
#include <stdint.h>
+/**
+ * \file
+ * \ingroup object
+ * ns3::TypeId declaration; inline and template implementations.
+ */
+
namespace ns3 {
class ObjectBase;
--- a/src/core/model/type-traits.h Tue May 05 00:42:26 2015 +0200
+++ b/src/core/model/type-traits.h Mon May 04 17:55:16 2015 -0700
@@ -20,6 +20,12 @@
#ifndef TYPE_TRAITS_H
#define TYPE_TRAITS_H
+/**
+ * \file
+ * \ingroup object
+ * TypeTraits introspection template.
+ */
+
/** Type trait reference values */
template <typename T>
struct TypeTraits