diff --git a/src/topology-read/examples/topology-example-sim.cc b/src/topology-read/examples/topology-example-sim.cc index 03f57bbe3..0cfe798a1 100644 --- a/src/topology-read/examples/topology-example-sim.cc +++ b/src/topology-read/examples/topology-example-sim.cc @@ -36,6 +36,34 @@ #include "ns3/topology-read-module.h" #include +/** + * \file + * \ingroup topology + * Example of TopologyReader: .read in a topology in a specificed format. + */ + +// Document the available input files +/** + * \file RocketFuel_toposample_1239_weights.txt + * Example TopologyReader input file in RocketFuel format; + * to read this with topology-example-sim.cc use \c --format=Rocket + */ +/** + * \file Inet_toposample.txt + * Example TopologyReader input file in Inet format; + * to read this with topology-example-sim.cc use \c --format=Inet + */ +/** + * \file Inet_small_toposample.txt + * Example TopologyReader input file in Inet format; + * to read this with topology-example-sim.cc use \c --format=Inet + */ +/** + * \file Orbis_toposample.txt + * Example TopologyReader input file in Orbis format; + * to read this with topology-example-sim.cc use \c --format=Orbis + */ + using namespace ns3; NS_LOG_COMPONENT_DEFINE ("TopologyCreationExperiment"); diff --git a/src/topology-read/helper/topology-reader-helper.cc b/src/topology-read/helper/topology-reader-helper.cc index fdfd60681..a8c7915d0 100644 --- a/src/topology-read/helper/topology-reader-helper.cc +++ b/src/topology-read/helper/topology-reader-helper.cc @@ -26,6 +26,12 @@ #include "ns3/rocketfuel-topology-reader.h" #include "ns3/log.h" +/** + * \file + * \ingroup topology + * ns3::TopologyHelper implementation. + */ + namespace ns3 { NS_LOG_COMPONENT_DEFINE ("TopologyReaderHelper"); diff --git a/src/topology-read/helper/topology-reader-helper.h b/src/topology-read/helper/topology-reader-helper.h index b0a3d9b9d..29237617c 100644 --- a/src/topology-read/helper/topology-reader-helper.h +++ b/src/topology-read/helper/topology-reader-helper.h @@ -25,6 +25,12 @@ #include "ns3/topology-reader.h" #include +/** + * \file + * \ingroup topology + * ns3::TopologyHelper declaration. + */ + namespace ns3 { /** diff --git a/src/topology-read/model/inet-topology-reader.cc b/src/topology-read/model/inet-topology-reader.cc index 50fab340b..69940fa64 100644 --- a/src/topology-read/model/inet-topology-reader.cc +++ b/src/topology-read/model/inet-topology-reader.cc @@ -28,6 +28,12 @@ #include "inet-topology-reader.h" +/** + * \file + * \ingroup topology + * ns3::InetTopologyReader implementation. + */ + namespace ns3 { NS_LOG_COMPONENT_DEFINE ("InetTopologyReader"); diff --git a/src/topology-read/model/inet-topology-reader.h b/src/topology-read/model/inet-topology-reader.h index 42fb716c7..2b0f213ee 100644 --- a/src/topology-read/model/inet-topology-reader.h +++ b/src/topology-read/model/inet-topology-reader.h @@ -24,6 +24,12 @@ #include "topology-reader.h" +/** + * \file + * \ingroup topology + * ns3::InetTopologyReader declaration. + */ + namespace ns3 { diff --git a/src/topology-read/model/orbis-topology-reader.cc b/src/topology-read/model/orbis-topology-reader.cc index 1cc5e8faa..efba4def8 100644 --- a/src/topology-read/model/orbis-topology-reader.cc +++ b/src/topology-read/model/orbis-topology-reader.cc @@ -27,6 +27,12 @@ #include "orbis-topology-reader.h" +/** + * \file + * \ingroup topology + * ns3::OrbisTopologyReader implementation. + */ + namespace ns3 { NS_LOG_COMPONENT_DEFINE ("OrbisTopologyReader"); diff --git a/src/topology-read/model/orbis-topology-reader.h b/src/topology-read/model/orbis-topology-reader.h index 03a1d6608..54f1e0cca 100644 --- a/src/topology-read/model/orbis-topology-reader.h +++ b/src/topology-read/model/orbis-topology-reader.h @@ -24,6 +24,12 @@ #include "topology-reader.h" +/** + * \file + * \ingroup topology + * ns3::OrbisTopologyReader declaration. + */ + namespace ns3 { diff --git a/src/topology-read/model/rocketfuel-topology-reader.cc b/src/topology-read/model/rocketfuel-topology-reader.cc index a44017a70..00863148d 100644 --- a/src/topology-read/model/rocketfuel-topology-reader.cc +++ b/src/topology-read/model/rocketfuel-topology-reader.cc @@ -28,6 +28,12 @@ #include "ns3/node-container.h" #include "rocketfuel-topology-reader.h" +/** + * \file + * \ingroup topology + * ns3::RocketfuelTopologyReader implementation. + */ + namespace ns3 { NS_LOG_COMPONENT_DEFINE ("RocketfuelTopologyReader"); diff --git a/src/topology-read/model/rocketfuel-topology-reader.h b/src/topology-read/model/rocketfuel-topology-reader.h index 43493d196..a8e580a5d 100644 --- a/src/topology-read/model/rocketfuel-topology-reader.h +++ b/src/topology-read/model/rocketfuel-topology-reader.h @@ -23,6 +23,12 @@ #include "topology-reader.h" +/** + * \file + * \ingroup topology + * ns3::RocketfuelTopologyReader declaration. + */ + namespace ns3 { diff --git a/src/topology-read/model/topology-reader.cc b/src/topology-read/model/topology-reader.cc index f45706511..a55277260 100644 --- a/src/topology-read/model/topology-reader.cc +++ b/src/topology-read/model/topology-reader.cc @@ -23,6 +23,12 @@ #include "topology-reader.h" +/** + * \file + * \ingroup topology + * ns3::TopologyReader implementation. + */ + namespace ns3 { NS_LOG_COMPONENT_DEFINE ("TopologyReader"); diff --git a/src/topology-read/model/topology-reader.h b/src/topology-read/model/topology-reader.h index 6d609f954..af9b2ed10 100644 --- a/src/topology-read/model/topology-reader.h +++ b/src/topology-read/model/topology-reader.h @@ -29,6 +29,12 @@ #include "ns3/node.h" +/** + * \file + * \ingroup topology + * ns3::TopologyReader declaration. + */ + namespace ns3 { class NodeContainer; diff --git a/src/topology-read/test/rocketfuel-topology-reader-test-suite.cc b/src/topology-read/test/rocketfuel-topology-reader-test-suite.cc index b287bbea6..9eb56b785 100644 --- a/src/topology-read/test/rocketfuel-topology-reader-test-suite.cc +++ b/src/topology-read/test/rocketfuel-topology-reader-test-suite.cc @@ -37,6 +37,12 @@ using namespace ns3; * \defgroup topology-test Topology module tests */ +/** + * \file + * \ingroup topology-test + * ns3::RockefuelTopologyReader test suite. + */ + /** * \ingroup topology-test * \ingroup tests