From 06d0ff20d03c57e79aa927e56632a886a4338936 Mon Sep 17 00:00:00 2001 From: Tommaso Pecorella Date: Sun, 27 Nov 2022 23:57:03 +0100 Subject: [PATCH] doc: (fixes #817) various fixes highlighted by doxygen 1.9.6 --- doc/modules | 7 ++-- examples/ipv6/CMakeLists.txt | 8 ++--- examples/ipv6/{ping6.cc => ping6-example.cc} | 0 .../ipv6/{radvd.cc => radvd-one-prefix.cc} | 3 +- src/aodv/model/aodv-packet.h | 1 + src/aodv/model/aodv-routing-protocol.h | 17 +++++---- src/aodv/test/aodv-id-cache-test-suite.cc | 5 ++- src/aodv/test/aodv-regression.cc | 2 -- src/aodv/test/aodv-test-suite.cc | 10 ------ src/aodv/test/loopback.cc | 1 - src/config-store/model/model-node-creator.h | 2 -- src/config-store/model/model-typeid-creator.h | 1 - src/core/examples/length-example.cc | 22 ++++++------ .../examples/test-string-value-formatting.cc | 2 +- src/core/model/attribute-helper.h | 7 +++- src/core/model/int64x64-double.h | 4 +-- src/core/model/length.cc | 2 -- src/dsdv/test/dsdv-testcase.cc | 6 ++-- src/energy/examples/CMakeLists.txt | 4 +-- ...rce.cc => li-ion-energy-source-example.cc} | 3 +- .../examples/flowmon-parse-results.py | 10 ------ src/internet/helper/ipv4-routing-helper.h | 9 ----- src/internet/helper/ipv6-routing-helper.h | 9 ----- src/internet/model/tcp-rate-ops.cc | 4 +-- src/internet/model/tcp-rate-ops.h | 4 +-- .../global-route-manager-impl-test-suite.cc | 3 +- .../test/ipv4-address-generator-test-suite.cc | 6 ---- .../test/ipv4-address-helper-test-suite.cc | 5 --- src/internet/test/ipv4-deduplication-test.cc | 4 --- src/internet/test/ipv4-forwarding-test.cc | 2 -- src/internet/test/ipv4-fragmentation-test.cc | 3 -- .../test/ipv4-global-routing-test-suite.cc | 9 ----- src/internet/test/ipv4-header-test.cc | 2 -- .../test/ipv4-list-routing-test-suite.cc | 5 --- .../test/ipv4-packet-info-tag-test-suite.cc | 2 -- src/internet/test/ipv4-raw-test.cc | 2 -- src/internet/test/ipv4-rip-test.cc | 4 --- .../test/ipv4-static-routing-test-suite.cc | 2 -- src/internet/test/ipv4-test.cc | 2 -- .../test/ipv6-address-duplication-test.cc | 2 -- .../test/ipv6-address-generator-test-suite.cc | 6 ---- .../test/ipv6-address-helper-test-suite.cc | 2 -- .../test/ipv6-dual-stack-test-suite.cc | 2 -- .../test/ipv6-extension-header-test-suite.cc | 7 ---- src/internet/test/ipv6-forwarding-test.cc | 2 -- src/internet/test/ipv6-fragmentation-test.cc | 3 -- .../test/ipv6-list-routing-test-suite.cc | 5 --- .../test/ipv6-packet-info-tag-test-suite.cc | 2 -- src/internet/test/ipv6-raw-test.cc | 2 -- src/internet/test/ipv6-ripng-test.cc | 4 --- src/internet/test/ipv6-test.cc | 2 -- src/internet/test/neighbor-cache-test.cc | 8 ----- src/internet/test/rtt-test.cc | 2 -- src/internet/test/tcp-bbr-test.cc | 1 - src/internet/test/tcp-bic-test.cc | 3 -- src/internet/test/tcp-bytes-in-flight-test.cc | 2 -- .../test/tcp-classic-recovery-test.cc | 1 - src/internet/test/tcp-cong-avoid-test.cc | 2 -- src/internet/test/tcp-datasentcb-test.cc | 3 -- src/internet/test/tcp-dctcp-test.cc | 4 --- src/internet/test/tcp-ecn-test.cc | 3 -- src/internet/test/tcp-endpoint-bug2211.cc | 2 -- src/internet/test/tcp-error-model.h | 3 -- src/internet/test/tcp-fast-retr-test.cc | 2 -- src/internet/test/tcp-general-test.h | 4 --- src/internet/test/tcp-header-test.cc | 4 --- src/internet/test/tcp-highspeed-test.cc | 4 --- src/internet/test/tcp-htcp-test.cc | 2 -- src/internet/test/tcp-hybla-test.cc | 2 -- src/internet/test/tcp-illinois-test.cc | 2 -- src/internet/test/tcp-ledbat-test.cc | 4 --- src/internet/test/tcp-linux-reno-test.cc | 3 -- src/internet/test/tcp-loss-test.cc | 2 -- src/internet/test/tcp-lp-test.cc | 4 --- src/internet/test/tcp-option-test.cc | 3 -- src/internet/test/tcp-pacing-test.cc | 2 -- src/internet/test/tcp-pkts-acked-test.cc | 3 -- src/internet/test/tcp-prr-recovery-test.cc | 1 - src/internet/test/tcp-rate-ops-test.cc | 2 -- src/internet/test/tcp-rto-test.cc | 4 --- src/internet/test/tcp-rtt-estimation.cc | 3 -- src/internet/test/tcp-rx-buffer-test.cc | 1 - src/internet/test/tcp-sack-permitted-test.cc | 1 - src/internet/test/tcp-scalable-test.cc | 3 -- src/internet/test/tcp-slow-start-test.cc | 3 -- .../test/tcp-syn-connection-failed-test.cc | 2 -- src/internet/test/tcp-test.cc | 2 -- src/internet/test/tcp-timestamp-test.cc | 3 -- src/internet/test/tcp-tx-buffer-test.cc | 1 - src/internet/test/tcp-vegas-test.cc | 1 - src/internet/test/tcp-veno-test.cc | 2 -- src/internet/test/tcp-wscaling-test.cc | 2 -- src/internet/test/tcp-yeah-test.cc | 3 -- src/internet/test/tcp-zero-window-test.cc | 2 -- src/internet/test/udp-test.cc | 5 --- src/lte/model/epc-s11-sap.h | 10 ------ src/lte/test/epc-test-gtpu.h | 2 +- src/lte/test/epc-test-s1u-downlink.cc | 3 -- src/lte/test/epc-test-s1u-uplink.cc | 4 --- src/lte/test/lte-ffr-simple.h | 1 - src/lte/test/lte-simple-helper.h | 1 - .../lte-test-aggregation-throughput-scale.cc | 4 +++ ...-test-carrier-aggregation-configuration.cc | 6 ++-- src/lte/test/lte-test-carrier-aggregation.cc | 4 +++ src/lte/test/lte-test-carrier-aggregation.h | 6 ++-- src/lte/test/lte-test-cell-selection.cc | 4 +++ src/lte/test/lte-test-cqa-ff-mac-scheduler.cc | 4 +++ src/lte/test/lte-test-cqa-ff-mac-scheduler.h | 3 -- src/lte/test/lte-test-cqi-generation.cc | 4 +++ src/lte/test/lte-test-cqi-generation.h | 3 -- src/lte/test/lte-test-deactivate-bearer.cc | 6 +++- src/lte/test/lte-test-deactivate-bearer.h | 2 -- .../test/lte-test-downlink-power-control.cc | 4 +++ .../test/lte-test-downlink-power-control.h | 4 --- src/lte/test/lte-test-downlink-sinr.cc | 4 +++ src/lte/test/lte-test-downlink-sinr.h | 3 -- src/lte/test/lte-test-earfcn.cc | 8 ++--- src/lte/test/lte-test-entities.h | 4 --- .../test/lte-test-fdbet-ff-mac-scheduler.cc | 4 +++ .../test/lte-test-fdbet-ff-mac-scheduler.h | 3 -- .../test/lte-test-fdmt-ff-mac-scheduler.cc | 4 +++ src/lte/test/lte-test-fdmt-ff-mac-scheduler.h | 2 -- .../test/lte-test-fdtbfq-ff-mac-scheduler.cc | 4 +++ .../test/lte-test-fdtbfq-ff-mac-scheduler.h | 3 -- src/lte/test/lte-test-frequency-reuse.cc | 4 +++ src/lte/test/lte-test-frequency-reuse.h | 10 ------ src/lte/test/lte-test-harq.cc | 4 +++ src/lte/test/lte-test-harq.h | 2 -- src/lte/test/lte-test-interference-fr.cc | 4 +++ src/lte/test/lte-test-interference-fr.h | 3 -- src/lte/test/lte-test-interference.cc | 4 +++ src/lte/test/lte-test-interference.h | 2 -- src/lte/test/lte-test-ipv6-routing.cc | 7 ++-- src/lte/test/lte-test-link-adaptation.cc | 4 +++ src/lte/test/lte-test-link-adaptation.h | 2 -- src/lte/test/lte-test-mimo.cc | 4 +++ src/lte/test/lte-test-mimo.h | 2 -- src/lte/test/lte-test-pathloss-model.cc | 4 +++ src/lte/test/lte-test-pathloss-model.h | 2 -- src/lte/test/lte-test-pf-ff-mac-scheduler.cc | 4 +++ src/lte/test/lte-test-pf-ff-mac-scheduler.h | 3 -- src/lte/test/lte-test-phy-error-model.cc | 4 +++ src/lte/test/lte-test-phy-error-model.h | 3 -- src/lte/test/lte-test-primary-cell-change.cc | 4 +++ src/lte/test/lte-test-pss-ff-mac-scheduler.cc | 4 +++ src/lte/test/lte-test-pss-ff-mac-scheduler.h | 3 -- src/lte/test/lte-test-radio-link-failure.cc | 4 +++ src/lte/test/lte-test-rlc-am-e2e.cc | 4 +++ src/lte/test/lte-test-rlc-am-e2e.h | 2 -- src/lte/test/lte-test-rlc-am-transmitter.cc | 4 +++ src/lte/test/lte-test-rlc-am-transmitter.h | 6 ---- src/lte/test/lte-test-rlc-um-e2e.cc | 4 +++ src/lte/test/lte-test-rlc-um-e2e.h | 2 -- src/lte/test/lte-test-rlc-um-transmitter.cc | 4 +++ src/lte/test/lte-test-rlc-um-transmitter.h | 6 ---- src/lte/test/lte-test-rr-ff-mac-scheduler.cc | 4 +++ src/lte/test/lte-test-rr-ff-mac-scheduler.h | 2 -- .../test/lte-test-secondary-cell-handover.cc | 6 ++-- .../test/lte-test-secondary-cell-selection.cc | 4 +++ .../test/lte-test-spectrum-value-helper.cc | 8 ++--- .../test/lte-test-tdbet-ff-mac-scheduler.cc | 4 +++ .../test/lte-test-tdbet-ff-mac-scheduler.h | 3 -- .../test/lte-test-tdmt-ff-mac-scheduler.cc | 4 +++ src/lte/test/lte-test-tdmt-ff-mac-scheduler.h | 2 -- .../test/lte-test-tdtbfq-ff-mac-scheduler.cc | 4 +++ .../test/lte-test-tdtbfq-ff-mac-scheduler.h | 3 -- src/lte/test/lte-test-tta-ff-mac-scheduler.cc | 4 +++ src/lte/test/lte-test-tta-ff-mac-scheduler.h | 2 -- src/lte/test/lte-test-ue-measurements.cc | 20 +++++++++++ src/lte/test/lte-test-ue-measurements.h | 10 ------ src/lte/test/lte-test-ue-phy.h | 1 - src/lte/test/lte-test-uplink-power-control.cc | 4 +++ src/lte/test/lte-test-uplink-power-control.h | 5 --- src/lte/test/lte-test-uplink-sinr.cc | 4 +++ src/lte/test/lte-test-uplink-sinr.h | 3 -- src/lte/test/test-asn1-encoding.cc | 20 +++-------- src/lte/test/test-epc-tft-classifier.cc | 6 ++-- src/lte/test/test-lte-antenna.cc | 8 +++-- src/lte/test/test-lte-epc-e2e-data.cc | 4 +-- src/lte/test/test-lte-handover-delay.cc | 3 +- src/lte/test/test-lte-handover-failure.cc | 2 -- src/lte/test/test-lte-handover-target.cc | 5 ++- src/lte/test/test-lte-rlc-header.cc | 3 -- src/lte/test/test-lte-rrc.cc | 7 ++-- src/lte/test/test-lte-x2-handover-measures.cc | 9 +++-- src/lte/test/test-lte-x2-handover.cc | 9 +++-- src/mesh/test/dot11s/dot11s-test-suite.cc | 3 -- .../test/dot11s/hwmp-proactive-regression.h | 1 - .../test/dot11s/hwmp-reactive-regression.h | 1 - .../test/dot11s/hwmp-simplest-regression.h | 1 - .../dot11s/hwmp-target-flags-regression.h | 1 - src/mesh/test/dot11s/pmp-regression.h | 1 - src/mesh/test/dot11s/regression.cc | 1 - src/mesh/test/flame/flame-regression.h | 1 - src/mesh/test/flame/flame-test-suite.cc | 3 -- src/mesh/test/flame/regression.cc | 1 - ...h-information-element-vector-test-suite.cc | 3 +- src/mobility/test/geo-to-cartesian-test.cc | 8 +++-- src/mobility/test/mobility-test-suite.cc | 11 +++--- .../test/mobility-trace-test-suite.cc | 8 +++-- .../test/ns2-mobility-helper-test-suite.cc | 2 -- .../test/rand-cart-around-geo-test.cc | 8 +++-- ...ate-random-waypoint-mobility-model-test.cc | 2 -- .../test/waypoint-mobility-model-test.cc | 3 -- src/mpi/model/null-message-mpi-interface.h | 2 +- src/netanim/test/netanim-test.cc | 5 +-- src/network/test/buffer-test.cc | 7 ++-- src/olsr/model/olsr-header.cc | 2 +- .../examples/topology-example-sim.cc | 36 +++++++------------ .../rocketfuel-topology-reader-test-suite.cc | 14 ++++---- .../model/traffic-control-layer.h | 6 ++-- .../adaptive-red-queue-disc-test-suite.cc | 4 +-- .../test/cobalt-queue-disc-test-suite.cc | 7 +--- .../test/codel-queue-disc-test-suite.cc | 8 ----- .../test/fifo-queue-disc-test-suite.cc | 3 -- .../test/pie-queue-disc-test-suite.cc | 3 -- .../test/prio-queue-disc-test-suite.cc | 4 --- .../test/queue-disc-traces-test-suite.cc | 6 ---- .../test/red-queue-disc-test-suite.cc | 3 -- .../test/tbf-queue-disc-test-suite.cc | 3 -- .../test/tc-flow-control-test-suite.cc | 3 -- .../examples/CMakeLists.txt | 4 +-- ...evice.cc => virtual-net-device-example.cc} | 3 +- src/visualizer/visualizer/core.py | 7 ++-- src/visualizer/visualizer/ipython_view.py | 21 +---------- utils/print-introspected-doxygen.cc | 2 -- 226 files changed, 328 insertions(+), 639 deletions(-) rename examples/ipv6/{ping6.cc => ping6-example.cc} (100%) rename examples/ipv6/{radvd.cc => radvd-one-prefix.cc} (99%) rename src/energy/examples/{li-ion-energy-source.cc => li-ion-energy-source-example.cc} (99%) rename src/virtual-net-device/examples/{virtual-net-device.cc => virtual-net-device-example.cc} (99%) diff --git a/doc/modules b/doc/modules index 80fc429d1..72b798fe3 100644 --- a/doc/modules +++ b/doc/modules @@ -1,17 +1,14 @@ /** * @file * @ingroup utils - * @brief Definition of support modules Constants, Utils, Example programs and + * @brief Definition of support modules Utils, Example programs and * Test suites. */ /** * @anchor modules_anchor * - * @defgroup constants Constants - * @brief Constants you can change - * * @defgroup utils Utils - * @brief The utils directory is for various programs and scripts related + * @brief The utils directory is for various programs and scripts related * to code coverage, test suites, style checking, and benchmarking. * * @defgroup examples Example programs diff --git a/examples/ipv6/CMakeLists.txt b/examples/ipv6/CMakeLists.txt index 2d64ecc16..ab81015ab 100644 --- a/examples/ipv6/CMakeLists.txt +++ b/examples/ipv6/CMakeLists.txt @@ -35,8 +35,8 @@ build_example( ) build_example( - NAME ping6 - SOURCE_FILES ping6.cc + NAME ping6-example + SOURCE_FILES ping6-example.cc LIBRARIES_TO_LINK ${libcsma} ${libinternet} @@ -44,8 +44,8 @@ build_example( ) build_example( - NAME radvd - SOURCE_FILES radvd.cc + NAME radvd-one-prefix + SOURCE_FILES radvd-one-prefix.cc LIBRARIES_TO_LINK ${libcsma} ${libinternet} diff --git a/examples/ipv6/ping6.cc b/examples/ipv6/ping6-example.cc similarity index 100% rename from examples/ipv6/ping6.cc rename to examples/ipv6/ping6-example.cc diff --git a/examples/ipv6/radvd.cc b/examples/ipv6/radvd-one-prefix.cc similarity index 99% rename from examples/ipv6/radvd.cc rename to examples/ipv6/radvd-one-prefix.cc index b3879134a..344536067 100644 --- a/examples/ipv6/radvd.cc +++ b/examples/ipv6/radvd-one-prefix.cc @@ -30,14 +30,13 @@ // // // // - Tracing of queues and packet receptions to file "radvd.tr" -#include "ns3/radvd.h" - #include "ns3/core-module.h" #include "ns3/csma-module.h" #include "ns3/internet-apps-module.h" #include "ns3/internet-module.h" #include "ns3/radvd-interface.h" #include "ns3/radvd-prefix.h" +#include "ns3/radvd.h" #include diff --git a/src/aodv/model/aodv-packet.h b/src/aodv/model/aodv-packet.h index 7c9ff69f1..47ad243cf 100644 --- a/src/aodv/model/aodv-packet.h +++ b/src/aodv/model/aodv-packet.h @@ -108,6 +108,7 @@ class TypeHeader : public Header /** * \brief Stream output operator * \param os output stream + * \param h the TypeHeader * \return updated stream */ std::ostream& operator<<(std::ostream& os, const TypeHeader& h); diff --git a/src/aodv/model/aodv-routing-protocol.h b/src/aodv/model/aodv-routing-protocol.h index 0dc2efc1d..637b1b890 100644 --- a/src/aodv/model/aodv-routing-protocol.h +++ b/src/aodv/model/aodv-routing-protocol.h @@ -260,7 +260,6 @@ class RoutingProtocol : public Ipv4RoutingProtocol ///< originated route discovery. bool m_enableHello; ///< Indicates whether a hello messages enable bool m_enableBroadcast; ///< Indicates whether a a broadcast data packets forwarding enable - //\} /// IP protocol Ptr m_ipv4; @@ -377,8 +376,10 @@ class RoutingProtocol : public Ipv4RoutingProtocol */ Ptr LoopbackRoute(const Ipv4Header& header, Ptr oif) const; - ///\name Receive control packets - //\{ + /** + * \name Receive control packets + * @{ + */ /** * Receive and process control packet * \param socket input socket @@ -410,10 +411,12 @@ class RoutingProtocol : public Ipv4RoutingProtocol */ /// Receive from node with address src void RecvError(Ptr p, Ipv4Address src); - //\} + /** @} */ - ///\name Send - //\{ + /** + * \name Send + * @{ + */ /** Forward packet from route request queue * \param dst destination address * \param route route to use @@ -459,7 +462,7 @@ class RoutingProtocol : public Ipv4RoutingProtocol * \param origin originating node IP address */ void SendRerrWhenNoRouteToForward(Ipv4Address dst, uint32_t dstSeqNo, Ipv4Address origin); - /// @} + /** @} */ /** * Send packet to destination socket diff --git a/src/aodv/test/aodv-id-cache-test-suite.cc b/src/aodv/test/aodv-id-cache-test-suite.cc index 41a7e50af..780f23fe1 100644 --- a/src/aodv/test/aodv-id-cache-test-suite.cc +++ b/src/aodv/test/aodv-id-cache-test-suite.cc @@ -33,13 +33,13 @@ namespace aodv { /** - * \ingroup aodv * \defgroup aodv-test AODV module tests + * \ingroup aodv + * \ingroup tests */ /** * \ingroup aodv-test - * \ingroup tests * * \brief Unit test for id cache */ @@ -111,7 +111,6 @@ IdCacheTest::CheckTimeout3() /** * \ingroup aodv-test - * \ingroup tests * * \brief Id Cache Test Suite */ diff --git a/src/aodv/test/aodv-regression.cc b/src/aodv/test/aodv-regression.cc index 053cb1e38..bad3baa27 100644 --- a/src/aodv/test/aodv-regression.cc +++ b/src/aodv/test/aodv-regression.cc @@ -45,7 +45,6 @@ using namespace ns3; /** * \ingroup aodv-test - * \ingroup tests * * \brief AODV regression test suite */ @@ -69,7 +68,6 @@ class AodvRegressionTestSuite : public TestSuite /** * \ingroup aodv-test - * \ingroup tests * * \brief Chain Regression Test */ diff --git a/src/aodv/test/aodv-test-suite.cc b/src/aodv/test/aodv-test-suite.cc index 8ecbf03cb..5f3f903de 100644 --- a/src/aodv/test/aodv-test-suite.cc +++ b/src/aodv/test/aodv-test-suite.cc @@ -30,7 +30,6 @@ namespace aodv /** * \ingroup aodv-test - * \ingroup tests * * \brief Unit test for neighbors */ @@ -136,7 +135,6 @@ NeighborTest::DoRun() /** * \ingroup aodv-test - * \ingroup tests * * \brief Type header test case */ @@ -164,7 +162,6 @@ struct TypeHeaderTest : public TestCase /** * \ingroup aodv-test - * \ingroup tests * * \brief Unit test for RREQ */ @@ -224,7 +221,6 @@ struct RreqHeaderTest : public TestCase /** * \ingroup aodv-test - * \ingroup tests * * \brief Unit test for RREP */ @@ -282,7 +278,6 @@ struct RrepHeaderTest : public TestCase /** * \ingroup aodv-test - * \ingroup tests * * \brief Unit test for RREP-ACK */ @@ -307,7 +302,6 @@ struct RrepAckHeaderTest : public TestCase /** * \ingroup aodv-test - * \ingroup tests * * \brief Unit test for RERR */ @@ -342,7 +336,6 @@ struct RerrHeaderTest : public TestCase /** * \ingroup aodv-test - * \ingroup tests * * \brief Unit test for AODV routing table entry */ @@ -559,7 +552,6 @@ AodvRqueueTest::CheckTimeout() /** * \ingroup aodv-test - * \ingroup tests * * \brief Unit test for AODV routing table entry */ @@ -653,7 +645,6 @@ struct AodvRtableEntryTest : public TestCase /** * \ingroup aodv-test - * \ingroup tests * * \brief Unit test for AODV routing table */ @@ -741,7 +732,6 @@ struct AodvRtableTest : public TestCase /** * \ingroup aodv-test - * \ingroup tests * * \brief AODV test suite */ diff --git a/src/aodv/test/loopback.cc b/src/aodv/test/loopback.cc index 6250d52fa..eb9b276bc 100644 --- a/src/aodv/test/loopback.cc +++ b/src/aodv/test/loopback.cc @@ -191,7 +191,6 @@ LoopbackTestCase::DoRun() /** * \ingroup aodv-test - * \ingroup tests * * \brief AODV Loopback test suite */ diff --git a/src/config-store/model/model-node-creator.h b/src/config-store/model/model-node-creator.h index c8e5b04d0..3d7a46fb9 100644 --- a/src/config-store/model/model-node-creator.h +++ b/src/config-store/model/model-node-creator.h @@ -36,9 +36,7 @@ enum struct ModelNode { /** - * \enum node type * \brief node type structure - * */ enum { diff --git a/src/config-store/model/model-typeid-creator.h b/src/config-store/model/model-typeid-creator.h index 007680dd0..2763d2440 100644 --- a/src/config-store/model/model-typeid-creator.h +++ b/src/config-store/model/model-typeid-creator.h @@ -38,7 +38,6 @@ enum struct ModelTypeid { /** - * \enum node type * \brief Whether the node represents an attribute or TypeId */ enum diff --git a/src/core/examples/length-example.cc b/src/core/examples/length-example.cc index c6a2b9282..e23e5a34d 100644 --- a/src/core/examples/length-example.cc +++ b/src/core/examples/length-example.cc @@ -23,17 +23,21 @@ #include /** - * \file + * \defgroup length-examples Demonstrates usage of the ns3::Length class * \ingroup core-examples * \ingroup length + */ + +/** + * \file + * \ingroup length-examples * Demonstrates usage of the ns3::Length class */ using namespace ns3; /** - * \ingroup core-examples - * \ingroup length + * \ingroup length-examples * \brief Demonstrates the use of ns3::Length constructors. */ void @@ -55,8 +59,7 @@ Constructors() } /** - * \ingroup core-examples - * \ingroup length + * \ingroup length-examples * \brief Demonstrates the use of ns3::Length conversions. */ void @@ -75,8 +78,7 @@ Conversions() } /** - * \ingroup core-examples - * \ingroup length + * \ingroup length-examples * \brief Demonstrates the use of ns3::Length arithmetic operators. */ void @@ -103,8 +105,7 @@ ArithmeticOperators() } /** - * \ingroup core-examples - * \ingroup length + * \ingroup length-examples * \brief Demonstrates the use of ns3::Length equality operators. */ void @@ -141,8 +142,7 @@ EqualityOperators() } /** - * \ingroup core-examples - * \ingroup length + * \ingroup length-examples * \brief Demonstrates the use of ns3::Length multiplications and divisions. */ void diff --git a/src/core/examples/test-string-value-formatting.cc b/src/core/examples/test-string-value-formatting.cc index 8652154e6..526af8a13 100644 --- a/src/core/examples/test-string-value-formatting.cc +++ b/src/core/examples/test-string-value-formatting.cc @@ -18,7 +18,7 @@ #include "ns3/core-module.h" /** - * \defgroup string-value-formatting + * \defgroup string-value-formatting StringValue parsing tests * Check that StringValue parses complex values correctly. */ diff --git a/src/core/model/attribute-helper.h b/src/core/model/attribute-helper.h index a0f453bba..6f98305eb 100644 --- a/src/core/model/attribute-helper.h +++ b/src/core/model/attribute-helper.h @@ -111,7 +111,12 @@ MakeSimpleAttributeChecker(std::string name, std::string underlying) std::string GetValueTypeName() const override { - return m_type; + if (m_type.rfind("ns3::", 0) == 0) + { + // m_type already starts with "ns3::" + return m_type; + } + return "ns3::" + m_type; } bool HasUnderlyingTypeInformation() const override diff --git a/src/core/model/int64x64-double.h b/src/core/model/int64x64-double.h index 8eec8e1e2..b965003c1 100644 --- a/src/core/model/int64x64-double.h +++ b/src/core/model/int64x64-double.h @@ -314,7 +314,7 @@ class int64x64_t * \name Arithmetic Operators * Arithmetic operators for int64x64_t. */ - /* + /** * @{ * Arithmetic operator. * \param [in] lhs Left hand argument @@ -367,7 +367,7 @@ class int64x64_t * \name Unary Operators * Unary operators for int64x64_t. */ - /* + /** * @{ * Unary operator. * \param [in] lhs Left hand argument diff --git a/src/core/model/length.cc b/src/core/model/length.cc index 0f0cbd334..9a65fd354 100644 --- a/src/core/model/length.cc +++ b/src/core/model/length.cc @@ -849,6 +849,4 @@ Miles(double value) return Length(value, Length::Unit::Mile); } -/**@}*/ - } // namespace ns3 diff --git a/src/dsdv/test/dsdv-testcase.cc b/src/dsdv/test/dsdv-testcase.cc index cf57a1cf6..0248c4ec8 100644 --- a/src/dsdv/test/dsdv-testcase.cc +++ b/src/dsdv/test/dsdv-testcase.cc @@ -46,13 +46,13 @@ using namespace ns3; /** - * \ingroup dsdv-test + * \ingroup dsdv + * \ingroup tests * \defgroup dsdv-test DSDV module tests */ /** * \ingroup dsdv-test - * \ingroup tests * * \brief DSDV test case to verify the DSDV header * @@ -111,7 +111,6 @@ DsdvHeaderTestCase::DoRun() /** * \ingroup dsdv-test - * \ingroup tests * * \brief DSDV routing table tests (adding and looking up routes) */ @@ -213,7 +212,6 @@ DsdvTableTestCase::DoRun() /** * \ingroup dsdv-test - * \ingroup tests * * \brief DSDV test suite */ diff --git a/src/energy/examples/CMakeLists.txt b/src/energy/examples/CMakeLists.txt index b63b3152f..8fa2b88f5 100644 --- a/src/energy/examples/CMakeLists.txt +++ b/src/energy/examples/CMakeLists.txt @@ -1,6 +1,6 @@ build_lib_example( - NAME li-ion-energy-source - SOURCE_FILES li-ion-energy-source.cc + NAME li-ion-energy-source-example + SOURCE_FILES li-ion-energy-source-example.cc LIBRARIES_TO_LINK ${libcore} ${libenergy} ) diff --git a/src/energy/examples/li-ion-energy-source.cc b/src/energy/examples/li-ion-energy-source-example.cc similarity index 99% rename from src/energy/examples/li-ion-energy-source.cc rename to src/energy/examples/li-ion-energy-source-example.cc index 4c709f525..f3c02f01e 100644 --- a/src/energy/examples/li-ion-energy-source.cc +++ b/src/energy/examples/li-ion-energy-source-example.cc @@ -17,10 +17,9 @@ * Author: Andrea Sacco */ -#include "ns3/li-ion-energy-source.h" - #include "ns3/command-line.h" #include "ns3/energy-source-container.h" +#include "ns3/li-ion-energy-source.h" #include "ns3/log.h" #include "ns3/simple-device-energy-model.h" #include "ns3/simulator.h" diff --git a/src/flow-monitor/examples/flowmon-parse-results.py b/src/flow-monitor/examples/flowmon-parse-results.py index 0e854c69e..bbc3c9f8b 100644 --- a/src/flow-monitor/examples/flowmon-parse-results.py +++ b/src/flow-monitor/examples/flowmon-parse-results.py @@ -45,10 +45,6 @@ class Histogram(object): ## class variables ## @var bins # histogram bins - ## @var nbins - # number of bins - ## @var number_of_flows - # number of flows ## @var __slots_ # class variable list __slots_ = 'bins', 'nbins', 'number_of_flows' @@ -76,8 +72,6 @@ class Flow(object): # receive bit rate ## @var txBitrate # transmit bit rate - ## @var fiveTuple - # five tuple ## @var packetSizeMean # packet size mean ## @var probe_stats_unsorted @@ -140,14 +134,10 @@ class Flow(object): ## ProbeFlowStats class ProbeFlowStats(object): ## class variables - ## @var probeId - # probe ID ## @var packets # network packets ## @var bytes # bytes - ## @var delayFromFirstProbe - # delay from first probe ## @var __slots_ # class variable list __slots_ = ['probeId', 'packets', 'bytes', 'delayFromFirstProbe'] diff --git a/src/internet/helper/ipv4-routing-helper.h b/src/internet/helper/ipv4-routing-helper.h index be10da469..a373ac1be 100644 --- a/src/internet/helper/ipv4-routing-helper.h +++ b/src/internet/helper/ipv4-routing-helper.h @@ -284,15 +284,6 @@ class Ipv4RoutingHelper Time::Unit unit = Time::S); }; -/** - * \brief Request a specified routing protocol <T> from Ipv4RoutingProtocol protocol - * - * If protocol is Ipv4ListRouting, then protocol will be searched in the list, - * otherwise a simple DynamicCast will be performed - * - * \param protocol Smart pointer to Ipv4RoutingProtocol object - * \return a Smart Pointer to the requested protocol (zero if the protocol can't be found) - */ template Ptr Ipv4RoutingHelper::GetRouting(Ptr protocol) diff --git a/src/internet/helper/ipv6-routing-helper.h b/src/internet/helper/ipv6-routing-helper.h index 91a3c3698..e43ba68e3 100644 --- a/src/internet/helper/ipv6-routing-helper.h +++ b/src/internet/helper/ipv6-routing-helper.h @@ -284,15 +284,6 @@ class Ipv6RoutingHelper Time::Unit unit = Time::S); }; -/** - * \brief Request a specified routing protocol <T> from Ipv6RoutingProtocol protocol - * - * If protocol is Ipv6ListRouting, then protocol will be searched in the list, - * otherwise a simple DynamicCast will be performed - * - * \param protocol Smart pointer to Ipv6RoutingProtocol object - * \return a Smart Pointer to the requested protocol (zero if the protocol can't be found) - */ template Ptr Ipv6RoutingHelper::GetRouting(Ptr protocol) diff --git a/src/internet/model/tcp-rate-ops.cc b/src/internet/model/tcp-rate-ops.cc index e99790c78..e05c35926 100644 --- a/src/internet/model/tcp-rate-ops.cc +++ b/src/internet/model/tcp-rate-ops.cc @@ -238,7 +238,7 @@ TcpRateLinux::SkbSent(TcpTxItem* skb, bool isStartOfTransmission) } std::ostream& -operator<<(std::ostream& os, const TcpRateLinux::TcpRateConnection& rate) +operator<<(std::ostream& os, const TcpRateOps::TcpRateConnection& rate) { os << "m_delivered = " << rate.m_delivered << std::endl; os << "m_deliveredTime = " << rate.m_deliveredTime << std::endl; @@ -252,7 +252,7 @@ operator<<(std::ostream& os, const TcpRateLinux::TcpRateConnection& rate) } std::ostream& -operator<<(std::ostream& os, const TcpRateLinux::TcpRateSample& sample) +operator<<(std::ostream& os, const TcpRateOps::TcpRateSample& sample) { os << "m_deliveryRate = " << sample.m_deliveryRate << std::endl; os << " m_isAppLimited = " << sample.m_isAppLimited << std::endl; diff --git a/src/internet/model/tcp-rate-ops.h b/src/internet/model/tcp-rate-ops.h index a8711d2e2..9877767ea 100644 --- a/src/internet/model/tcp-rate-ops.h +++ b/src/internet/model/tcp-rate-ops.h @@ -259,7 +259,7 @@ class TcpRateLinux : public TcpRateOps * \param sample the TcpRateLinux::TcpRateSample to print. * \returns The output stream. */ -std::ostream& operator<<(std::ostream& os, const TcpRateLinux::TcpRateSample& sample); +std::ostream& operator<<(std::ostream& os, const TcpRateOps::TcpRateSample& sample); /** * \brief Output operator. @@ -267,7 +267,7 @@ std::ostream& operator<<(std::ostream& os, const TcpRateLinux::TcpRateSample& sa * \param rate the TcpRateLinux::TcpRateConnection to print. * \returns The output stream. */ -std::ostream& operator<<(std::ostream& os, const TcpRateLinux::TcpRateConnection& rate); +std::ostream& operator<<(std::ostream& os, const TcpRateOps::TcpRateConnection& rate); /** * Comparison operator diff --git a/src/internet/test/global-route-manager-impl-test-suite.cc b/src/internet/test/global-route-manager-impl-test-suite.cc index 922c0904e..991d6652b 100644 --- a/src/internet/test/global-route-manager-impl-test-suite.cc +++ b/src/internet/test/global-route-manager-impl-test-suite.cc @@ -32,12 +32,12 @@ using namespace ns3; /** * \ingroup internet + * \ingroup tests * \defgroup internet-test internet module tests */ /** * \ingroup internet-test - * \ingroup tests * * \brief Global Route Manager Test */ @@ -224,7 +224,6 @@ GlobalRouteManagerImplTestCase::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief Global Route Manager TestSuite */ diff --git a/src/internet/test/ipv4-address-generator-test-suite.cc b/src/internet/test/ipv4-address-generator-test-suite.cc index 65a138451..8f649c34a 100644 --- a/src/internet/test/ipv4-address-generator-test-suite.cc +++ b/src/internet/test/ipv4-address-generator-test-suite.cc @@ -23,7 +23,6 @@ using namespace ns3; /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 network number Test */ @@ -84,7 +83,6 @@ NetworkNumberAllocatorTestCase::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 address allocator Test */ @@ -142,7 +140,6 @@ AddressAllocatorTestCase::DoTeardown() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 network and address allocator Test */ @@ -214,7 +211,6 @@ NetworkAndAddressTestCase::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 AddressGenerator example (sort of) Test */ @@ -273,7 +269,6 @@ ExampleAddressGeneratorTestCase::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 address collision Test */ @@ -346,7 +341,6 @@ AddressCollisionTestCase::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 Address Generator TestSuite */ diff --git a/src/internet/test/ipv4-address-helper-test-suite.cc b/src/internet/test/ipv4-address-helper-test-suite.cc index 51f99cfdc..c7ba89925 100644 --- a/src/internet/test/ipv4-address-helper-test-suite.cc +++ b/src/internet/test/ipv4-address-helper-test-suite.cc @@ -24,7 +24,6 @@ using namespace ns3; /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 network allocator helper Test */ @@ -78,7 +77,6 @@ NetworkAllocatorHelperTestCase::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 address allocator helper Test */ @@ -132,7 +130,6 @@ AddressAllocatorHelperTestCase::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 reset allocator helper Test */ @@ -201,7 +198,6 @@ ResetAllocatorHelperTestCase::DoTeardown() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 address helper Test */ @@ -281,7 +277,6 @@ IpAddressHelperTestCasev4::DoTeardown() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 Address Helper TestSuite */ diff --git a/src/internet/test/ipv4-deduplication-test.cc b/src/internet/test/ipv4-deduplication-test.cc index b2e71b1ca..90b9b5b36 100644 --- a/src/internet/test/ipv4-deduplication-test.cc +++ b/src/internet/test/ipv4-deduplication-test.cc @@ -57,7 +57,6 @@ using namespace ns3; /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 Deduplication Test * @@ -546,7 +545,6 @@ Ipv4DeduplicationTest::CheckDrops(const std::string& name) /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 Deduplication TestSuite */ @@ -572,7 +570,6 @@ static Ipv4DeduplicationTestSuite /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 Deduplication Performance Test * @@ -730,7 +727,6 @@ Ipv4DeduplicationPerformanceTest::DoSendData(Ptr socket, Address to, uin /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 Deduplication Performance TestSuite */ diff --git a/src/internet/test/ipv4-forwarding-test.cc b/src/internet/test/ipv4-forwarding-test.cc index e9471f641..1fbeeb809 100644 --- a/src/internet/test/ipv4-forwarding-test.cc +++ b/src/internet/test/ipv4-forwarding-test.cc @@ -44,7 +44,6 @@ using namespace ns3; /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 Forwarding Test */ @@ -227,7 +226,6 @@ Ipv4ForwardingTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 Forwarding TestSuite */ diff --git a/src/internet/test/ipv4-fragmentation-test.cc b/src/internet/test/ipv4-fragmentation-test.cc index a5f39615a..0c3e5dba5 100644 --- a/src/internet/test/ipv4-fragmentation-test.cc +++ b/src/internet/test/ipv4-fragmentation-test.cc @@ -59,7 +59,6 @@ class UdpSocketImpl; /** * \ingroup internet-test - * \ingroup tests * * \brief Tag used in IPv4 Fragmentation Test */ @@ -125,7 +124,6 @@ class IPv4TestTag : public Tag /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 Fragmentation Test */ @@ -579,7 +577,6 @@ Ipv4FragmentationTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 Fragmentation TestSuite */ diff --git a/src/internet/test/ipv4-global-routing-test-suite.cc b/src/internet/test/ipv4-global-routing-test-suite.cc index 9feb2ccf0..56932ecda 100644 --- a/src/internet/test/ipv4-global-routing-test-suite.cc +++ b/src/internet/test/ipv4-global-routing-test-suite.cc @@ -118,7 +118,6 @@ NS_LOG_COMPONENT_DEFINE("Ipv4GlobalRoutingTestSuite"); /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 GlobalRouting Link test */ @@ -203,7 +202,6 @@ LinkTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 GlobalRouting LAN test */ @@ -285,7 +283,6 @@ LanTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 GlobalRouting Two Link test */ @@ -405,7 +402,6 @@ TwoLinkTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 GlobalRouting Two LAN test */ @@ -506,7 +502,6 @@ TwoLanTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 GlobalRouting Bridge test */ @@ -690,7 +685,6 @@ BridgeTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 GlobalRouting Two bridges test */ @@ -848,7 +842,6 @@ TwoBridgeTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 Dynamic GlobalRouting test */ @@ -1159,7 +1152,6 @@ Ipv4DynamicGlobalRoutingTestCase::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 Dynamic GlobalRouting /32 test */ @@ -1323,7 +1315,6 @@ Ipv4GlobalRoutingSlash32TestCase::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 GlobalRouting TestSuite */ diff --git a/src/internet/test/ipv4-header-test.cc b/src/internet/test/ipv4-header-test.cc index e52b0b4d5..e6a39a9d6 100644 --- a/src/internet/test/ipv4-header-test.cc +++ b/src/internet/test/ipv4-header-test.cc @@ -53,7 +53,6 @@ using namespace ns3; /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 Header Test */ @@ -293,7 +292,6 @@ Ipv4HeaderTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 Header TestSuite */ diff --git a/src/internet/test/ipv4-list-routing-test-suite.cc b/src/internet/test/ipv4-list-routing-test-suite.cc index 505f0f85c..a111b7720 100644 --- a/src/internet/test/ipv4-list-routing-test-suite.cc +++ b/src/internet/test/ipv4-list-routing-test-suite.cc @@ -24,7 +24,6 @@ using namespace ns3; /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 dummy routing class (A) */ @@ -77,7 +76,6 @@ class Ipv4ARouting : public Ipv4RoutingProtocol /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 dummy routing class (B) */ @@ -130,7 +128,6 @@ class Ipv4BRouting : public Ipv4RoutingProtocol /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 ListRouting negative test. */ @@ -165,7 +162,6 @@ Ipv4ListRoutingNegativeTestCase::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 ListRouting positive test. */ @@ -205,7 +201,6 @@ Ipv4ListRoutingPositiveTestCase::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 ListRouting TestSuite */ diff --git a/src/internet/test/ipv4-packet-info-tag-test-suite.cc b/src/internet/test/ipv4-packet-info-tag-test-suite.cc index cf342e2af..9af127cbb 100644 --- a/src/internet/test/ipv4-packet-info-tag-test-suite.cc +++ b/src/internet/test/ipv4-packet-info-tag-test-suite.cc @@ -54,7 +54,6 @@ using namespace ns3; /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 PacketInfoTag Test */ @@ -209,7 +208,6 @@ Ipv4PacketInfoTagTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 PacketInfoTag TestSuite */ diff --git a/src/internet/test/ipv4-raw-test.cc b/src/internet/test/ipv4-raw-test.cc index d5bedd701..3e90f67c2 100644 --- a/src/internet/test/ipv4-raw-test.cc +++ b/src/internet/test/ipv4-raw-test.cc @@ -54,7 +54,6 @@ using namespace ns3; /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 RAW Socket Test */ @@ -372,7 +371,6 @@ Ipv4RawSocketImplTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 RAW Socket TestSuite */ diff --git a/src/internet/test/ipv4-rip-test.cc b/src/internet/test/ipv4-rip-test.cc index 61ddcd070..1945d02fb 100644 --- a/src/internet/test/ipv4-rip-test.cc +++ b/src/internet/test/ipv4-rip-test.cc @@ -46,7 +46,6 @@ using namespace ns3; /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 RIP Test */ @@ -276,7 +275,6 @@ Ipv4RipTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 RIP count to infinity Test */ @@ -510,7 +508,6 @@ Ipv4RipCountToInfinityTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 RIP SplitHorizon strategy Test */ @@ -699,7 +696,6 @@ Ipv4RipSplitHorizonStrategyTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 RIP TestSuite */ diff --git a/src/internet/test/ipv4-static-routing-test-suite.cc b/src/internet/test/ipv4-static-routing-test-suite.cc index 1817948e4..0ae1d94af 100644 --- a/src/internet/test/ipv4-static-routing-test-suite.cc +++ b/src/internet/test/ipv4-static-routing-test-suite.cc @@ -39,7 +39,6 @@ using namespace ns3; /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 StaticRouting /32 Test */ @@ -210,7 +209,6 @@ Ipv4StaticRoutingSlash32TestCase::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 StaticRouting /32 TestSuite */ diff --git a/src/internet/test/ipv4-test.cc b/src/internet/test/ipv4-test.cc index 4b83c4a03..53c59cbf3 100644 --- a/src/internet/test/ipv4-test.cc +++ b/src/internet/test/ipv4-test.cc @@ -32,7 +32,6 @@ using namespace ns3; /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 Test */ @@ -123,7 +122,6 @@ Ipv4L3ProtocolTestCase::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv4 TestSuite */ diff --git a/src/internet/test/ipv6-address-duplication-test.cc b/src/internet/test/ipv6-address-duplication-test.cc index 101b2784a..d1c514294 100644 --- a/src/internet/test/ipv6-address-duplication-test.cc +++ b/src/internet/test/ipv6-address-duplication-test.cc @@ -44,7 +44,6 @@ using namespace ns3; /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 Duplicate Address Detection Test */ @@ -118,7 +117,6 @@ Ipv6DadTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 Duplicate Address Detection TestSuite */ diff --git a/src/internet/test/ipv6-address-generator-test-suite.cc b/src/internet/test/ipv6-address-generator-test-suite.cc index c3b711a00..3896e4f22 100644 --- a/src/internet/test/ipv6-address-generator-test-suite.cc +++ b/src/internet/test/ipv6-address-generator-test-suite.cc @@ -24,7 +24,6 @@ using namespace ns3; /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 network number allocator Test */ @@ -83,7 +82,6 @@ NetworkNumber6AllocatorTestCase::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 address allocator Test */ @@ -148,7 +146,6 @@ AddressAllocator6TestCase::DoTeardown() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 network number and address allocator Test */ @@ -200,7 +197,6 @@ NetworkAndAddress6TestCase::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 example of an address generator Test */ @@ -265,7 +261,6 @@ ExampleAddress6GeneratorTestCase::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 address collision Test */ @@ -338,7 +333,6 @@ AddressCollision6TestCase::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 address generator TestSuite */ diff --git a/src/internet/test/ipv6-address-helper-test-suite.cc b/src/internet/test/ipv6-address-helper-test-suite.cc index 4b90aea80..bbea29d0c 100644 --- a/src/internet/test/ipv6-address-helper-test-suite.cc +++ b/src/internet/test/ipv6-address-helper-test-suite.cc @@ -29,7 +29,6 @@ using namespace ns3; /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 AddressHelper Test */ @@ -170,7 +169,6 @@ IpAddressHelperTestCasev6::DoTeardown() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 AddressHelper TestSuite */ diff --git a/src/internet/test/ipv6-dual-stack-test-suite.cc b/src/internet/test/ipv6-dual-stack-test-suite.cc index 2cd137797..54716c2e4 100644 --- a/src/internet/test/ipv6-dual-stack-test-suite.cc +++ b/src/internet/test/ipv6-dual-stack-test-suite.cc @@ -52,7 +52,6 @@ NS_LOG_COMPONENT_DEFINE("Ipv6DualStackTestSuite"); /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 dual stack Test */ @@ -354,7 +353,6 @@ DualStackTestCase::DoTeardown() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 dual stack TestSuite */ diff --git a/src/internet/test/ipv6-extension-header-test-suite.cc b/src/internet/test/ipv6-extension-header-test-suite.cc index 2e8c98f31..215292a45 100644 --- a/src/internet/test/ipv6-extension-header-test-suite.cc +++ b/src/internet/test/ipv6-extension-header-test-suite.cc @@ -35,7 +35,6 @@ using namespace ns3; /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 extensions Test: Empty option field. */ @@ -76,7 +75,6 @@ class TestEmptyOptionField : public TestCase /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 extensions Test: Option without alignment. */ @@ -100,7 +98,6 @@ class OptionWithoutAlignmentHeader : public Ipv6OptionHeader /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 extensions Test: Test the option without alignment. */ @@ -151,7 +148,6 @@ class TestOptionWithoutAlignment : public TestCase /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 extensions Test: Option with alignment. */ @@ -180,7 +176,6 @@ class OptionWithAlignmentHeader : public Ipv6OptionHeader /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 extensions Test: Test the option with alignment. */ @@ -238,7 +233,6 @@ class TestOptionWithAlignment : public TestCase /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 extensions Test: Test an option already aligned. */ @@ -278,7 +272,6 @@ class TestFulfilledAlignment : public TestCase /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 extensions TestSuite. */ diff --git a/src/internet/test/ipv6-forwarding-test.cc b/src/internet/test/ipv6-forwarding-test.cc index cb60a5916..54eda9b84 100644 --- a/src/internet/test/ipv6-forwarding-test.cc +++ b/src/internet/test/ipv6-forwarding-test.cc @@ -44,7 +44,6 @@ using namespace ns3; /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 Forwarding Test */ @@ -212,7 +211,6 @@ Ipv6ForwardingTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 Forwarding TestSuite */ diff --git a/src/internet/test/ipv6-fragmentation-test.cc b/src/internet/test/ipv6-fragmentation-test.cc index 64b9c2317..4b509ded7 100644 --- a/src/internet/test/ipv6-fragmentation-test.cc +++ b/src/internet/test/ipv6-fragmentation-test.cc @@ -67,7 +67,6 @@ class UdpSocketImpl; /** * \ingroup internet-test - * \ingroup tests * * \brief Tag used in IPv6 Fragmentation Test */ @@ -133,7 +132,6 @@ class IPv6TestTag : public Tag /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 Fragmentation Test */ @@ -618,7 +616,6 @@ Ipv6FragmentationTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 Fragmentation TestSuite */ diff --git a/src/internet/test/ipv6-list-routing-test-suite.cc b/src/internet/test/ipv6-list-routing-test-suite.cc index d4b606f43..bdb081db0 100644 --- a/src/internet/test/ipv6-list-routing-test-suite.cc +++ b/src/internet/test/ipv6-list-routing-test-suite.cc @@ -25,7 +25,6 @@ using namespace ns3; /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 dummy routing class (A) */ @@ -92,7 +91,6 @@ class Ipv6ARouting : public Ipv6RoutingProtocol /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 dummy routing class (B) */ @@ -159,7 +157,6 @@ class Ipv6BRouting : public Ipv6RoutingProtocol /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 ListRouting negative test. */ @@ -194,7 +191,6 @@ Ipv6ListRoutingNegativeTestCase::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 ListRouting positive test. */ @@ -234,7 +230,6 @@ Ipv6ListRoutingPositiveTestCase::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 ListRouting TestSuite */ diff --git a/src/internet/test/ipv6-packet-info-tag-test-suite.cc b/src/internet/test/ipv6-packet-info-tag-test-suite.cc index 5de73199b..b77474f26 100644 --- a/src/internet/test/ipv6-packet-info-tag-test-suite.cc +++ b/src/internet/test/ipv6-packet-info-tag-test-suite.cc @@ -76,7 +76,6 @@ using namespace ns3; /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 PacketInfoTag Test */ @@ -245,7 +244,6 @@ Ipv6PacketInfoTagTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 PacketInfoTag TestSuite */ diff --git a/src/internet/test/ipv6-raw-test.cc b/src/internet/test/ipv6-raw-test.cc index 6ae8c7726..aeda29c8d 100644 --- a/src/internet/test/ipv6-raw-test.cc +++ b/src/internet/test/ipv6-raw-test.cc @@ -56,7 +56,6 @@ using namespace ns3; /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 RAW Socket Test */ @@ -324,7 +323,6 @@ Ipv6RawSocketImplTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 RAW Socket TestSuite */ diff --git a/src/internet/test/ipv6-ripng-test.cc b/src/internet/test/ipv6-ripng-test.cc index b24cbe20a..a070fcafc 100644 --- a/src/internet/test/ipv6-ripng-test.cc +++ b/src/internet/test/ipv6-ripng-test.cc @@ -45,7 +45,6 @@ using namespace ns3; /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 RIPng Test */ @@ -276,7 +275,6 @@ Ipv6RipngTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 RIPng count to infinity Test */ @@ -509,7 +507,6 @@ Ipv6RipngCountToInfinityTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 RIPng SplitHorizon strategy Test */ @@ -698,7 +695,6 @@ Ipv6RipngSplitHorizonStrategyTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 RIPng TestSuite */ diff --git a/src/internet/test/ipv6-test.cc b/src/internet/test/ipv6-test.cc index c94298ce3..fff151684 100644 --- a/src/internet/test/ipv6-test.cc +++ b/src/internet/test/ipv6-test.cc @@ -32,7 +32,6 @@ using namespace ns3; /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 Test */ @@ -180,7 +179,6 @@ Ipv6L3ProtocolTestCase::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief IPv6 TestSuite */ diff --git a/src/internet/test/neighbor-cache-test.cc b/src/internet/test/neighbor-cache-test.cc index 12598a780..59edf934b 100644 --- a/src/internet/test/neighbor-cache-test.cc +++ b/src/internet/test/neighbor-cache-test.cc @@ -41,7 +41,6 @@ using namespace ns3; /** * \ingroup internet-test - * \ingroup tests * * \brief Dynamic Neighbor Cache Test */ @@ -542,7 +541,6 @@ DynamicNeighborCacheTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief Neighbor cache on Channel Test */ @@ -632,7 +630,6 @@ ChannelTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief Neighbor Cache on NetDeviceContainer Test */ @@ -723,7 +720,6 @@ NetDeviceContainerTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief Neighbor Cache on InterfaceContainer Test */ @@ -814,7 +810,6 @@ InterfaceContainerTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief Neighbor Cache Flush Test */ @@ -922,7 +917,6 @@ FlushTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief Neighbor Cache on Overlapped Scope Test */ @@ -1022,7 +1016,6 @@ DuplicateTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief Dynamic Neighbor Cache on Reduced Scope Test */ @@ -1230,7 +1223,6 @@ DynamicPartialTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief NeighborCache TestSuite */ diff --git a/src/internet/test/rtt-test.cc b/src/internet/test/rtt-test.cc index 9c7dafcfc..4860f57f3 100644 --- a/src/internet/test/rtt-test.cc +++ b/src/internet/test/rtt-test.cc @@ -28,7 +28,6 @@ NS_LOG_COMPONENT_DEFINE("RttEstimatorTestSuite"); /** * \ingroup internet-test - * \ingroup tests * * \brief RTT estimator Test */ @@ -181,7 +180,6 @@ RttEstimatorTestCase::DoTeardown() /** * \ingroup internet-test - * \ingroup tests * * \brief RTT estimator TestSuite */ diff --git a/src/internet/test/tcp-bbr-test.cc b/src/internet/test/tcp-bbr-test.cc index 7c276615c..d5a883ca7 100644 --- a/src/internet/test/tcp-bbr-test.cc +++ b/src/internet/test/tcp-bbr-test.cc @@ -182,7 +182,6 @@ TcpBbrCheckGainValuesTest::ExecuteTest() /** * \ingroup internet-test - * \ingroup tests * * \brief TCP BBR TestSuite */ diff --git a/src/internet/test/tcp-bic-test.cc b/src/internet/test/tcp-bic-test.cc index 6052a55b1..a36c512ad 100644 --- a/src/internet/test/tcp-bic-test.cc +++ b/src/internet/test/tcp-bic-test.cc @@ -28,7 +28,6 @@ NS_LOG_COMPONENT_DEFINE("TcpBicTestSuite"); /** * \ingroup internet-test - * \ingroup tests * * \brief Testing the congestion avoidance increment on TcpBic */ @@ -191,7 +190,6 @@ TcpBicIncrementTest::Update(Ptr tcb) /** * \ingroup internet-test - * \ingroup tests * * \brief Testing the congestion avoidance decrement on TcpBic */ @@ -305,7 +303,6 @@ TcpBicDecrementTest::ExecuteTest() /** * \ingroup internet-test - * \ingroup tests * * \brief TCP Bic TestSuite */ diff --git a/src/internet/test/tcp-bytes-in-flight-test.cc b/src/internet/test/tcp-bytes-in-flight-test.cc index 789ad5123..59072c56d 100644 --- a/src/internet/test/tcp-bytes-in-flight-test.cc +++ b/src/internet/test/tcp-bytes-in-flight-test.cc @@ -29,7 +29,6 @@ NS_LOG_COMPONENT_DEFINE("TcpBytesInFlightTestSuite"); /** * \ingroup internet-test - * \ingroup tests * * \brief Check the value of BytesInFlight against a home-made guess * @@ -283,7 +282,6 @@ TcpBytesInFlightTest::FinalChecks() /** * \ingroup internet-test - * \ingroup tests * * \brief TestSuite: Check the value of BytesInFlight against a home-made guess */ diff --git a/src/internet/test/tcp-classic-recovery-test.cc b/src/internet/test/tcp-classic-recovery-test.cc index 8d1cbdacc..1a9e5fcab 100644 --- a/src/internet/test/tcp-classic-recovery-test.cc +++ b/src/internet/test/tcp-classic-recovery-test.cc @@ -118,7 +118,6 @@ ClassicRecoveryTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief Classic Recovery TestSuite */ diff --git a/src/internet/test/tcp-cong-avoid-test.cc b/src/internet/test/tcp-cong-avoid-test.cc index bf7aee615..ac2d0f9d3 100644 --- a/src/internet/test/tcp-cong-avoid-test.cc +++ b/src/internet/test/tcp-cong-avoid-test.cc @@ -28,7 +28,6 @@ NS_LOG_COMPONENT_DEFINE("TcpNewRenoCongAvoidTest"); /** * \ingroup internet-test - * \ingroup tests * * \brief Test the behavior of RFC congestion avoidance * @@ -181,7 +180,6 @@ TcpNewRenoCongAvoidNormalTest::NormalClose(SocketWho who) /** * \ingroup internet-test - * \ingroup tests * * \brief TestSuite for the behavior of RFC congestion avoidance */ diff --git a/src/internet/test/tcp-datasentcb-test.cc b/src/internet/test/tcp-datasentcb-test.cc index 09e64180e..9c973914d 100644 --- a/src/internet/test/tcp-datasentcb-test.cc +++ b/src/internet/test/tcp-datasentcb-test.cc @@ -28,7 +28,6 @@ NS_LOG_COMPONENT_DEFINE("TcpDatSentCbTest"); /** * \ingroup internet-test - * \ingroup tests * * \brief Socket that the 50% of the times saves the entire packet in the buffer, * while in the other 50% saves only half the packet. @@ -90,7 +89,6 @@ TcpSocketHalfAck::ReceivedData(Ptr packet, const TcpHeader& tcpHeader) /** * \ingroup internet-test - * \ingroup tests * * \brief Data Sent callback test * @@ -164,7 +162,6 @@ TcpDataSentCbTestCase::CreateReceiverSocket(Ptr node) /** * \ingroup internet-test - * \ingroup tests * * \brief TestSuite: Data Sent callback */ diff --git a/src/internet/test/tcp-dctcp-test.cc b/src/internet/test/tcp-dctcp-test.cc index 9c87255ec..c534efed0 100644 --- a/src/internet/test/tcp-dctcp-test.cc +++ b/src/internet/test/tcp-dctcp-test.cc @@ -39,7 +39,6 @@ NS_LOG_COMPONENT_DEFINE("TcpDctcpTestSuite"); /** * \ingroup internet-test - * \ingroup tests * * \brief Validates the setting of ECT and ECE codepoints for DCTCP enabled traffic */ @@ -209,7 +208,6 @@ TcpDctcpCodePointsTest::ConfigureEnvironment() /** * \ingroup internet-test - * \ingroup tests * * \brief A TCP socket which sends a data packet with CE flags set for test 3. * @@ -554,7 +552,6 @@ TcpDctcpCodePointsTest::CreateReceiverSocket(Ptr node) /** * \ingroup internet-test - * \ingroup tests * * \brief DCTCP should be same as Linux during slow start */ @@ -655,7 +652,6 @@ TcpDctcpToLinuxReno::ExecuteTest() /** * \ingroup internet-test - * \ingroup tests * * \brief TCP DCTCP TestSuite */ diff --git a/src/internet/test/tcp-ecn-test.cc b/src/internet/test/tcp-ecn-test.cc index e1c0bdc52..c35393c9d 100644 --- a/src/internet/test/tcp-ecn-test.cc +++ b/src/internet/test/tcp-ecn-test.cc @@ -42,7 +42,6 @@ NS_LOG_COMPONENT_DEFINE("TcpEcnTestSuite"); /** * \ingroup internet-test - * \ingroup tests * * \brief checks if ECT, CWR and ECE bits are set correctly in different scenarios * @@ -81,7 +80,6 @@ class TcpEcnTest : public TcpGeneralTest /** * \ingroup internet-test - * \ingroup tests * * \brief A TCP socket which sends certain data packets with CE flags set for tests 5 and 6. * @@ -580,7 +578,6 @@ TcpEcnTest::CreateSenderSocket(Ptr node) /** * \ingroup internet-test - * \ingroup tests * * \brief TCP ECN TestSuite */ diff --git a/src/internet/test/tcp-endpoint-bug2211.cc b/src/internet/test/tcp-endpoint-bug2211.cc index 04074e690..d220664b0 100644 --- a/src/internet/test/tcp-endpoint-bug2211.cc +++ b/src/internet/test/tcp-endpoint-bug2211.cc @@ -27,7 +27,6 @@ using namespace ns3; /** * \ingroup internet-test - * \ingroup tests * * \brief Test for bug 2211. * @@ -151,7 +150,6 @@ TcpEndPointBug2211Test::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief TestSuite for bug 2211 - It must be used with valgrind. */ diff --git a/src/internet/test/tcp-error-model.h b/src/internet/test/tcp-error-model.h index e9c3437bf..aaad04868 100644 --- a/src/internet/test/tcp-error-model.h +++ b/src/internet/test/tcp-error-model.h @@ -27,7 +27,6 @@ namespace ns3 /** * \ingroup internet-test - * \ingroup tests * * \brief A general (TCP-aware) error model. * @@ -74,7 +73,6 @@ class TcpGeneralErrorModel : public ErrorModel /** * \ingroup internet-test - * \ingroup tests * * \brief An error model TCP aware: it drops the sequence number declared. * @@ -121,7 +119,6 @@ class TcpSeqErrorModel : public TcpGeneralErrorModel /** * \ingroup internet-test - * \ingroup tests * * \brief Error model which drop packets with specified TCP flags. * diff --git a/src/internet/test/tcp-fast-retr-test.cc b/src/internet/test/tcp-fast-retr-test.cc index 2c03103f7..6edf53f41 100644 --- a/src/internet/test/tcp-fast-retr-test.cc +++ b/src/internet/test/tcp-fast-retr-test.cc @@ -29,7 +29,6 @@ NS_LOG_COMPONENT_DEFINE("TcpFastRetrTest"); /** * \ingroup internet-test - * \ingroup tests * * \brief Test the fast retransmission * @@ -431,7 +430,6 @@ TcpFastRetrTest::FinalChecks() /** * \ingroup internet-test - * \ingroup tests * * \brief Testsuite for the fast retransmission */ diff --git a/src/internet/test/tcp-general-test.h b/src/internet/test/tcp-general-test.h index b76ea5888..3a98e8b3c 100644 --- a/src/internet/test/tcp-general-test.h +++ b/src/internet/test/tcp-general-test.h @@ -31,7 +31,6 @@ namespace ns3 /** * \ingroup internet-test - * \ingroup tests * * \brief Class for inserting callbacks special points of the flow of TCP sockets * @@ -151,7 +150,6 @@ class TcpSocketMsgBase : public ns3::TcpSocketBase /** * \ingroup internet-test - * \ingroup tests * * \brief A TCP socket which sends ACKs smaller than the segment received. * @@ -215,7 +213,6 @@ class TcpSocketSmallAcks : public TcpSocketMsgBase /** * \ingroup internet-test - * \ingroup tests * * \brief General infrastructure for TCP testing * @@ -1162,7 +1159,6 @@ class TcpGeneralTest : public TestCase /** * \ingroup internet-test - * \ingroup tests * * \brief Convenience function to retrieve the ACK state from a TCB * diff --git a/src/internet/test/tcp-header-test.cc b/src/internet/test/tcp-header-test.cc index 3fd1c9337..88ca988b0 100644 --- a/src/internet/test/tcp-header-test.cc +++ b/src/internet/test/tcp-header-test.cc @@ -41,7 +41,6 @@ using namespace ns3; /** * \ingroup internet-test - * \ingroup tests * * \brief TCP header Get/Set test. */ @@ -159,7 +158,6 @@ TcpHeaderGetSetTestCase::DoTeardown() /** * \ingroup internet-test - * \ingroup tests * * \brief TCP header with RFC793 Options test. */ @@ -386,7 +384,6 @@ TcpHeaderWithRFC793OptionTestCase::DoTeardown() /** * \ingroup internet-test - * \ingroup tests * * \brief TCP header Flags to Striing test. */ @@ -456,7 +453,6 @@ TcpHeaderFlagsToString::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief TCP header TestSuite */ diff --git a/src/internet/test/tcp-highspeed-test.cc b/src/internet/test/tcp-highspeed-test.cc index 881ac8356..0634b2677 100644 --- a/src/internet/test/tcp-highspeed-test.cc +++ b/src/internet/test/tcp-highspeed-test.cc @@ -28,7 +28,6 @@ NS_LOG_COMPONENT_DEFINE("TcpHighSpeedTestSuite"); /** * \ingroup internet-test - * \ingroup tests * * \brief Testing the congestion avoidance increment on TcpHighSpeed */ @@ -83,7 +82,6 @@ TcpHighSpeedIncrementTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief Testing the congestion avoidance decrement on TcpHighSpeed */ @@ -137,7 +135,6 @@ TcpHighSpeedDecrementTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief TcpHighSpeed Congestion window values to test. */ @@ -179,7 +176,6 @@ static const HighSpeedImportantValues highSpeedImportantValues[]{ /** * \ingroup internet-test - * \ingroup tests * * \brief TCP HighSpeed TestSuite */ diff --git a/src/internet/test/tcp-htcp-test.cc b/src/internet/test/tcp-htcp-test.cc index e6fe0aed0..df1f4a2d6 100644 --- a/src/internet/test/tcp-htcp-test.cc +++ b/src/internet/test/tcp-htcp-test.cc @@ -36,7 +36,6 @@ NS_LOG_COMPONENT_DEFINE("TcpHtcpTestSuite"); /** * \ingroup internet-test - * \ingroup tests * * \brief Testing the congestion avoidance increment on TcpHtcp */ @@ -148,7 +147,6 @@ TcpHtcpIncrementTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief TCP Htcp TestSuite. * diff --git a/src/internet/test/tcp-hybla-test.cc b/src/internet/test/tcp-hybla-test.cc index 18eb185fb..4ab82cad5 100644 --- a/src/internet/test/tcp-hybla-test.cc +++ b/src/internet/test/tcp-hybla-test.cc @@ -28,7 +28,6 @@ NS_LOG_COMPONENT_DEFINE("TcpHyblaTestSuite"); /** * \ingroup internet-test - * \ingroup tests * * \brief Testing the congestion avoidance increment on TcpHybla */ @@ -149,7 +148,6 @@ TcpHyblaIncrementTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief TCP Hybla TestSuite */ diff --git a/src/internet/test/tcp-illinois-test.cc b/src/internet/test/tcp-illinois-test.cc index ce8adb32c..48a14880b 100644 --- a/src/internet/test/tcp-illinois-test.cc +++ b/src/internet/test/tcp-illinois-test.cc @@ -35,7 +35,6 @@ NS_LOG_COMPONENT_DEFINE("TcpIllinoisTestSuite"); /** * \ingroup internet-test - * \ingroup tests * * \brief TcpIllinois C-AIMD algorithm tests. */ @@ -346,7 +345,6 @@ TcpIllinoisTest::GetSsThresh() /** * \ingroup internet-test - * \ingroup tests * * \brief TCP Illinois TestSuite */ diff --git a/src/internet/test/tcp-ledbat-test.cc b/src/internet/test/tcp-ledbat-test.cc index 9111dacff..fa07561ff 100644 --- a/src/internet/test/tcp-ledbat-test.cc +++ b/src/internet/test/tcp-ledbat-test.cc @@ -31,7 +31,6 @@ NS_LOG_COMPONENT_DEFINE("TcpLedbatTestSuite"); /** * \ingroup internet-test - * \ingroup tests * * \brief LEDBAT should be same as NewReno during slow start, and when timestamps are disabled */ @@ -132,7 +131,6 @@ TcpLedbatToNewReno::ExecuteTest() /** * \ingroup internet-test - * \ingroup tests * * \brief Test to validate cWnd increment in LEDBAT */ @@ -234,7 +232,6 @@ TcpLedbatIncrementTest::ExecuteTest() /** * \ingroup internet-test - * \ingroup tests * * \brief Test to validate cWnd decrement in LEDBAT */ @@ -339,7 +336,6 @@ TcpLedbatDecrementTest::ExecuteTest() /** * \ingroup internet-test - * \ingroup tests * * \brief TCP Ledbat TestSuite */ diff --git a/src/internet/test/tcp-linux-reno-test.cc b/src/internet/test/tcp-linux-reno-test.cc index 21bd93ef7..a8623a9d0 100644 --- a/src/internet/test/tcp-linux-reno-test.cc +++ b/src/internet/test/tcp-linux-reno-test.cc @@ -31,7 +31,6 @@ NS_LOG_COMPONENT_DEFINE("TcpLinuxRenoTest"); /** * \ingroup internet-test - * \ingroup tests * * This unit test checks that the slow start and congestion avoidance * behavior matches Linux behavior as follows: @@ -195,7 +194,6 @@ TcpLinuxRenoSSTest::DoTeardown() /** * \ingroup internet-test - * \ingroup tests * * This unit test checks that the slow start and congestion avoidance * behavior matches Linux behavior as follows: @@ -372,7 +370,6 @@ TcpLinuxRenoCongAvoidTest::DoTeardown() /** * \ingroup internet-test - * \ingroup tests * * \brief TestSuite for the behavior of Linux Reno */ diff --git a/src/internet/test/tcp-loss-test.cc b/src/internet/test/tcp-loss-test.cc index 4e8ed1fee..a06ad96d8 100644 --- a/src/internet/test/tcp-loss-test.cc +++ b/src/internet/test/tcp-loss-test.cc @@ -28,7 +28,6 @@ NS_LOG_COMPONENT_DEFINE("TcpLossTestSuite"); /** * \ingroup internet-test - * \ingroup tests * * \brief Check rollover of sequence number and how that affects loss recovery * @@ -176,7 +175,6 @@ TcpLargeTransferLossTest::FinalChecks() /** * \ingroup internet-test - * \ingroup tests * * Test various packet losses */ diff --git a/src/internet/test/tcp-lp-test.cc b/src/internet/test/tcp-lp-test.cc index 84d99a2e0..1dc29e70c 100644 --- a/src/internet/test/tcp-lp-test.cc +++ b/src/internet/test/tcp-lp-test.cc @@ -33,7 +33,6 @@ NS_LOG_COMPONENT_DEFINE("TcpLpTestSuite"); /** * \ingroup internet-test - * \ingroup tests * * \brief Testing the behaviour common to New Reno */ @@ -114,7 +113,6 @@ TcpLpToNewReno::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief Testing TcpLp when cwd exceeds threshold */ @@ -184,7 +182,6 @@ TcpLpInferenceTest1::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief Testing TcpLp when it is inference phase */ @@ -258,7 +255,6 @@ TcpLpInferenceTest2::DoRun() /** * \ingroup internet-test - * \ingroup tests * * Test the behaviour common to New Reno */ diff --git a/src/internet/test/tcp-option-test.cc b/src/internet/test/tcp-option-test.cc index 319c7e035..073ccdb6e 100644 --- a/src/internet/test/tcp-option-test.cc +++ b/src/internet/test/tcp-option-test.cc @@ -28,7 +28,6 @@ using namespace ns3; /** * \ingroup internet-test - * \ingroup tests * * \brief TCP Window Scaling option Test */ @@ -107,7 +106,6 @@ TcpOptionWSTestCase::DoTeardown() /** * \ingroup internet-test - * \ingroup tests * * \brief TCP TimeStamp option Test */ @@ -198,7 +196,6 @@ TcpOptionTSTestCase::DoTeardown() /** * \ingroup internet-test - * \ingroup tests * * \brief TCP options TestSuite */ diff --git a/src/internet/test/tcp-pacing-test.cc b/src/internet/test/tcp-pacing-test.cc index 73c3bdc64..8f2b4a2d6 100644 --- a/src/internet/test/tcp-pacing-test.cc +++ b/src/internet/test/tcp-pacing-test.cc @@ -30,7 +30,6 @@ NS_LOG_COMPONENT_DEFINE("TcpPacingTestSuite"); /** * \ingroup internet-test - * \ingroup tests * * \brief Test the behavior of TCP pacing * @@ -373,7 +372,6 @@ TcpPacingTest::NormalClose(SocketWho who) /** * \ingroup internet-test - * \ingroup tests * * \brief TestSuite for the behavior of TCP pacing */ diff --git a/src/internet/test/tcp-pkts-acked-test.cc b/src/internet/test/tcp-pkts-acked-test.cc index 4e88365d6..e5f99ec89 100644 --- a/src/internet/test/tcp-pkts-acked-test.cc +++ b/src/internet/test/tcp-pkts-acked-test.cc @@ -30,7 +30,6 @@ class DummyCongControl; /** * \ingroup internet-test - * \ingroup tests * * \brief Check the number of times that PktsAcked is called * @@ -76,7 +75,6 @@ class TcpPktsAckedOpenTest : public TcpGeneralTest /** * \ingroup internet-test - * \ingroup tests * * \brief Behaves as NewReno, except that each time PktsAcked is called, * a notification is sent to TcpPktsAckedOpenTest. @@ -173,7 +171,6 @@ TcpPktsAckedOpenTest::FinalChecks() /** * \ingroup internet-test - * \ingroup tests * * \brief PktsAcked is calls TestSuite. */ diff --git a/src/internet/test/tcp-prr-recovery-test.cc b/src/internet/test/tcp-prr-recovery-test.cc index fee210789..e7f1b7106 100644 --- a/src/internet/test/tcp-prr-recovery-test.cc +++ b/src/internet/test/tcp-prr-recovery-test.cc @@ -145,7 +145,6 @@ PrrRecoveryTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief PRR Recovery TestSuite */ diff --git a/src/internet/test/tcp-rate-ops-test.cc b/src/internet/test/tcp-rate-ops-test.cc index 5a8b95dfe..ab496d48a 100644 --- a/src/internet/test/tcp-rate-ops-test.cc +++ b/src/internet/test/tcp-rate-ops-test.cc @@ -184,7 +184,6 @@ TcpRateLinuxBasicTest::SkbDelivered(TcpTxItem* skb) /** * \ingroup internet-test - * \ingroup tests * * \brief Behaves as NewReno except HasCongControl returns true */ @@ -595,7 +594,6 @@ TcpRateLinuxWithBufferTest::DoTeardown() /** * \ingroup internet-test - * \ingroup tests * * \brief the TestSuite for the TcpRateLinux test case */ diff --git a/src/internet/test/tcp-rto-test.cc b/src/internet/test/tcp-rto-test.cc index a33956315..740fcea81 100644 --- a/src/internet/test/tcp-rto-test.cc +++ b/src/internet/test/tcp-rto-test.cc @@ -30,7 +30,6 @@ using namespace ns3; /** * \ingroup internet-test - * \ingroup tests * * \brief Testing the moments after an RTO expiration * @@ -167,7 +166,6 @@ TcpRtoTest::FinalChecks() /** * \ingroup internet-test - * \ingroup tests * * \brief Testing the ssthresh behavior after the RTO expires * @@ -314,7 +312,6 @@ TcpSsThreshRtoTest::AfterRTOExpired(const Ptr tcb, SocketW /** * \ingroup internet-test - * \ingroup tests * * \brief Testing the timing of RTO * @@ -510,7 +507,6 @@ TcpTimeRtoTest::FinalChecks() /** * \ingroup internet-test - * \ingroup tests * * \brief TCP RTO TestSuite */ diff --git a/src/internet/test/tcp-rtt-estimation.cc b/src/internet/test/tcp-rtt-estimation.cc index 4b6874c7a..2285ce039 100644 --- a/src/internet/test/tcp-rtt-estimation.cc +++ b/src/internet/test/tcp-rtt-estimation.cc @@ -29,7 +29,6 @@ NS_LOG_COMPONENT_DEFINE("TcpRttEstimationTestSuite"); /** * \ingroup internet-test - * \ingroup tests * * \brief Check Rtt calculations * @@ -192,7 +191,6 @@ TcpRttEstimationTest::FinalChecks() /** * \ingroup internet-test - * \ingroup tests * * \brief Check Rtt calculations with packet losses. * @@ -246,7 +244,6 @@ TcpRttEstimationWithLossTest::CreateReceiverErrorModel() /** * \ingroup internet-test - * \ingroup tests * * \brief TCP RTT estimation TestSuite */ diff --git a/src/internet/test/tcp-rx-buffer-test.cc b/src/internet/test/tcp-rx-buffer-test.cc index 32e4af422..d64c80d5e 100644 --- a/src/internet/test/tcp-rx-buffer-test.cc +++ b/src/internet/test/tcp-rx-buffer-test.cc @@ -296,7 +296,6 @@ TcpRxBufferTestCase::DoTeardown() /** * \ingroup internet-test - * \ingroup tests * * \brief the TestSuite for the TcpRxBuffer test case */ diff --git a/src/internet/test/tcp-sack-permitted-test.cc b/src/internet/test/tcp-sack-permitted-test.cc index a975f1b28..cf9bcef99 100644 --- a/src/internet/test/tcp-sack-permitted-test.cc +++ b/src/internet/test/tcp-sack-permitted-test.cc @@ -29,7 +29,6 @@ NS_LOG_COMPONENT_DEFINE("SackPermittedTestSuite"); /** * \ingroup internet-test - * \ingroup tests * * \brief Test case for checking the SACK-PERMITTED option. * diff --git a/src/internet/test/tcp-scalable-test.cc b/src/internet/test/tcp-scalable-test.cc index 67d55a545..b79e6704c 100644 --- a/src/internet/test/tcp-scalable-test.cc +++ b/src/internet/test/tcp-scalable-test.cc @@ -36,7 +36,6 @@ NS_LOG_COMPONENT_DEFINE("TcpScalableTestSuite"); /** * \ingroup internet-test - * \ingroup tests * * \brief Testing the congestion avoidance increment on TcpScalable */ @@ -106,7 +105,6 @@ TcpScalableIncrementTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief Testing the multiplicative decrease on TcpScalable */ @@ -165,7 +163,6 @@ TcpScalableDecrementTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief TcpScalable TestSuite. */ diff --git a/src/internet/test/tcp-slow-start-test.cc b/src/internet/test/tcp-slow-start-test.cc index c148b91de..6b326bfd3 100644 --- a/src/internet/test/tcp-slow-start-test.cc +++ b/src/internet/test/tcp-slow-start-test.cc @@ -30,7 +30,6 @@ NS_LOG_COMPONENT_DEFINE("TcpSlowStartTest"); /** * \ingroup internet-test - * \ingroup tests * * \brief Test the normal behavior for slow start * @@ -208,7 +207,6 @@ TcpSlowStartNormalTest::Rx(const Ptr p, const TcpHeader& h, Socket /** * \ingroup internet-test - * \ingroup tests * * \brief A slow start test using a socket which sends smaller ACKs * @@ -262,7 +260,6 @@ TcpSlowStartAttackerTest::CreateReceiverSocket(Ptr node) /** * \ingroup internet-test - * \ingroup tests * * \brief TCP Slow Start TestSuite. */ diff --git a/src/internet/test/tcp-syn-connection-failed-test.cc b/src/internet/test/tcp-syn-connection-failed-test.cc index 08b4bc7b5..bb418ebb9 100644 --- a/src/internet/test/tcp-syn-connection-failed-test.cc +++ b/src/internet/test/tcp-syn-connection-failed-test.cc @@ -27,7 +27,6 @@ using namespace ns3; /** * \ingroup internet-test - * \ingroup tests * * \brief Test that connection failed callback is called when * SYN retransmission number is exceeded. @@ -96,7 +95,6 @@ TcpSynConnectionFailedTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief TestSuite */ diff --git a/src/internet/test/tcp-test.cc b/src/internet/test/tcp-test.cc index eeefd585a..ee79b9a49 100644 --- a/src/internet/test/tcp-test.cc +++ b/src/internet/test/tcp-test.cc @@ -52,7 +52,6 @@ NS_LOG_COMPONENT_DEFINE("TcpTestSuite"); /** * \ingroup internet-test - * \ingroup tests * * \brief TCP Test - send string data from client to server and back. */ @@ -537,7 +536,6 @@ TcpTestCase::AddSimpleNetDevice6(Ptr node, Ipv6Address ipaddr, Ipv6Prefix /** * \ingroup internet-test - * \ingroup tests * * \brief TCP TestSuite - send string data from client to server and back. */ diff --git a/src/internet/test/tcp-timestamp-test.cc b/src/internet/test/tcp-timestamp-test.cc index 166e5edf3..409df36fa 100644 --- a/src/internet/test/tcp-timestamp-test.cc +++ b/src/internet/test/tcp-timestamp-test.cc @@ -29,7 +29,6 @@ NS_LOG_COMPONENT_DEFINE("TimestampTestSuite"); /** * \ingroup internet-test - * \ingroup tests * * \brief TCP TimeStamp enabling Test. */ @@ -210,7 +209,6 @@ TimestampTestCase::Rx(const Ptr p, const TcpHeader& h, SocketWho w /** * \ingroup internet-test - * \ingroup tests * * \brief TCP TimeStamp values Test. */ @@ -291,7 +289,6 @@ TimestampValueTestCase::Check() /** * \ingroup internet-test - * \ingroup tests * * \brief TCP TimeStamp TestSuite. */ diff --git a/src/internet/test/tcp-tx-buffer-test.cc b/src/internet/test/tcp-tx-buffer-test.cc index 35a608169..24ac62f15 100644 --- a/src/internet/test/tcp-tx-buffer-test.cc +++ b/src/internet/test/tcp-tx-buffer-test.cc @@ -432,7 +432,6 @@ TcpTxBufferTestCase::DoTeardown() /** * \ingroup internet-test - * \ingroup tests * * \brief the TestSuite for the TcpTxBuffer test case */ diff --git a/src/internet/test/tcp-vegas-test.cc b/src/internet/test/tcp-vegas-test.cc index 1d8d8137e..00ec3e4b1 100644 --- a/src/internet/test/tcp-vegas-test.cc +++ b/src/internet/test/tcp-vegas-test.cc @@ -202,7 +202,6 @@ TcpVegasTest::GetSsThresh(Ptr cong) /** * \ingroup internet-test - * \ingroup tests * * \brief TCP Vegas TestSuite */ diff --git a/src/internet/test/tcp-veno-test.cc b/src/internet/test/tcp-veno-test.cc index 68d0fb101..d1d04874c 100644 --- a/src/internet/test/tcp-veno-test.cc +++ b/src/internet/test/tcp-veno-test.cc @@ -35,7 +35,6 @@ NS_LOG_COMPONENT_DEFINE("TcpVenoTestSuite"); /** * \ingroup internet-test - * \ingroup tests * * \brief Testing the additive increase and multiplicative decrease of TcpVeno */ @@ -300,7 +299,6 @@ TcpVenoTest::NewReno_CongestionAvoidance(Ptr state, uint32_t seg /** * \ingroup internet-test - * \ingroup tests * * \brief TCP Veno TestSuite */ diff --git a/src/internet/test/tcp-wscaling-test.cc b/src/internet/test/tcp-wscaling-test.cc index 5514ef1e1..5a2ed814f 100644 --- a/src/internet/test/tcp-wscaling-test.cc +++ b/src/internet/test/tcp-wscaling-test.cc @@ -32,7 +32,6 @@ NS_LOG_COMPONENT_DEFINE("WScalingTestSuite"); // TODO: Check the buffer size and scaling option value /** * \ingroup internet-test - * \ingroup tests * * \brief TCP Window Scaling enabling Test. */ @@ -226,7 +225,6 @@ WScalingTestCase::Tx(const Ptr p, const TcpHeader& h, SocketWho wh /** * \ingroup internet-test - * \ingroup tests * * \brief TCP Window Scaling TestSuite. */ diff --git a/src/internet/test/tcp-yeah-test.cc b/src/internet/test/tcp-yeah-test.cc index ea8d870de..3694fde42 100644 --- a/src/internet/test/tcp-yeah-test.cc +++ b/src/internet/test/tcp-yeah-test.cc @@ -35,7 +35,6 @@ NS_LOG_COMPONENT_DEFINE("TcpYeahTestSuite"); /** * \ingroup internet-test - * \ingroup tests * * \brief Testing TcpYeah additive increase algorithm. */ @@ -216,7 +215,6 @@ TcpYeahIncrementTest::IncreaseWindow(Ptr cong) /** * \ingroup internet-test - * \ingroup tests * * \brief Testing TcpYeah multiplicative decrease algorithm */ @@ -359,7 +357,6 @@ TcpYeahDecrementTest::CalculateSsThresh(Ptr cong) /** * \ingroup internet-test - * \ingroup tests * * \brief TCP Yeah TestSuite */ diff --git a/src/internet/test/tcp-zero-window-test.cc b/src/internet/test/tcp-zero-window-test.cc index da0259811..5b6779eb4 100644 --- a/src/internet/test/tcp-zero-window-test.cc +++ b/src/internet/test/tcp-zero-window-test.cc @@ -28,7 +28,6 @@ NS_LOG_COMPONENT_DEFINE("TcpZeroWindowTestSuite"); /** * \ingroup internet-test - * \ingroup tests * * \brief Testing the congestion avoidance increment on TCP ZeroWindow */ @@ -249,7 +248,6 @@ TcpZeroWindowTest::ProcessedAck(const Ptr tcb, /** * \ingroup internet-test - * \ingroup tests * * \brief TCP ZeroWindow TestSuite */ diff --git a/src/internet/test/udp-test.cc b/src/internet/test/udp-test.cc index 56944228b..b8de69720 100644 --- a/src/internet/test/udp-test.cc +++ b/src/internet/test/udp-test.cc @@ -57,7 +57,6 @@ using namespace ns3; /** * \ingroup internet-test - * \ingroup tests * * \brief UDP Socket Loopback over IPv4 Test */ @@ -115,7 +114,6 @@ UdpSocketLoopbackTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief UDP Socket Loopback over IPv6 Test */ @@ -172,7 +170,6 @@ Udp6SocketLoopbackTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief UDP Socket over IPv4 Test */ @@ -524,7 +521,6 @@ UdpSocketImplTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief UDP Socket over IPv6 Test */ @@ -768,7 +764,6 @@ Udp6SocketImplTest::DoRun() /** * \ingroup internet-test - * \ingroup tests * * \brief UDP TestSuite */ diff --git a/src/lte/model/epc-s11-sap.h b/src/lte/model/epc-s11-sap.h index fb6f423b5..94f3922b6 100644 --- a/src/lte/model/epc-s11-sap.h +++ b/src/lte/model/epc-s11-sap.h @@ -271,11 +271,6 @@ class MemberEpcS11SapMme : public EpcS11SapMme C* m_owner; ///< owner class }; -/** - * Constructor - * - * \param owner the owner class - */ template MemberEpcS11SapMme::MemberEpcS11SapMme(C* owner) : m_owner(owner) @@ -331,11 +326,6 @@ class MemberEpcS11SapSgw : public EpcS11SapSgw C* m_owner; ///< owner class }; -/** - * Constructor - * - * \param owner the owner class - */ template MemberEpcS11SapSgw::MemberEpcS11SapSgw(C* owner) : m_owner(owner) diff --git a/src/lte/test/epc-test-gtpu.h b/src/lte/test/epc-test-gtpu.h index 36d155c17..7bd5f11ae 100644 --- a/src/lte/test/epc-test-gtpu.h +++ b/src/lte/test/epc-test-gtpu.h @@ -27,12 +27,12 @@ using namespace ns3; /** * \ingroup lte + * \ingroup tests * \defgroup lte-test lte module tests */ /** * \ingroup lte-test - * \ingroup tests * * \brief Test suite for testing GPRS tunnelling protocol header coding and decoding. */ diff --git a/src/lte/test/epc-test-s1u-downlink.cc b/src/lte/test/epc-test-s1u-downlink.cc index e8a29c9fa..a00e830ec 100644 --- a/src/lte/test/epc-test-s1u-downlink.cc +++ b/src/lte/test/epc-test-s1u-downlink.cc @@ -45,7 +45,6 @@ NS_LOG_COMPONENT_DEFINE("EpcTestS1uDownlink"); /** * \ingroup lte-test - * \ingroup tests * * \brief Custom structure for testing UE downlink data */ @@ -74,7 +73,6 @@ UeDlTestData::UeDlTestData(uint32_t n, uint32_t s) /** * \ingroup lte-test - * \ingroup tests * * \brief Custom structure for testing eNodeB downlink data, contains * the list of data structures for UEs @@ -86,7 +84,6 @@ struct EnbDlTestData /** * \ingroup lte-test - * \ingroup tests * * \brief EpcS1uDlTestCase class */ diff --git a/src/lte/test/epc-test-s1u-uplink.cc b/src/lte/test/epc-test-s1u-uplink.cc index f4f2961e9..1e80b1c48 100644 --- a/src/lte/test/epc-test-s1u-uplink.cc +++ b/src/lte/test/epc-test-s1u-uplink.cc @@ -52,7 +52,6 @@ NS_LOG_COMPONENT_DEFINE("EpcTestS1uUplink"); /** * \ingroup lte-test - * \ingroup tests * * A Udp client. Sends UDP packet carrying sequence number and time * stamp but also including the EpsBearerTag. This tag is normally @@ -250,7 +249,6 @@ EpsBearerTagUdpClient::Send() /** * \ingroup lte-test - * \ingroup tests * * \brief Custom test structure to hold information of data transmitted in the uplink per UE */ @@ -285,7 +283,6 @@ UeUlTestData::UeUlTestData(uint32_t n, uint32_t s, uint16_t r, uint8_t l) /** * \ingroup lte-test - * \ingroup tests * * \brief Custom structure containing information about data sent in the uplink * of eNodeB. Includes the information of the data sent in the uplink per UE. @@ -297,7 +294,6 @@ struct EnbUlTestData /** * \ingroup lte-test - * \ingroup tests * * \brief EpcS1uUlTestCase class */ diff --git a/src/lte/test/lte-ffr-simple.h b/src/lte/test/lte-ffr-simple.h index 5eff41a04..57220757f 100644 --- a/src/lte/test/lte-ffr-simple.h +++ b/src/lte/test/lte-ffr-simple.h @@ -34,7 +34,6 @@ namespace ns3 /** * \ingroup lte-test - * \ingroup tests * * \brief Simple Frequency Reuse algorithm implementation which uses only 1 sub-band. * Used to test Downlink Power Allocation. When Simple FR receives UE measurements diff --git a/src/lte/test/lte-simple-helper.h b/src/lte/test/lte-simple-helper.h index 56dbe8042..73754ef2e 100644 --- a/src/lte/test/lte-simple-helper.h +++ b/src/lte/test/lte-simple-helper.h @@ -37,7 +37,6 @@ class LteTestMac; /** * \ingroup lte-test - * \ingroup tests * * \brief A simplified version of LteHelper, that * is used for creation and configuration of LTE entities for testing purposes diff --git a/src/lte/test/lte-test-aggregation-throughput-scale.cc b/src/lte/test/lte-test-aggregation-throughput-scale.cc index 5e0d0931d..5bcb163a7 100644 --- a/src/lte/test/lte-test-aggregation-throughput-scale.cc +++ b/src/lte/test/lte-test-aggregation-throughput-scale.cc @@ -54,6 +54,10 @@ LteAggregationThroughputScaleTestSuite::LteAggregationThroughputScaleTestSuite() TestCase::QUICK); } +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LteAggregationThroughputScaleTestSuite g_lteAggregationThroughputScaleTestSuite; LteAggregationThroughputScaleTestCase::LteAggregationThroughputScaleTestCase(std::string name) diff --git a/src/lte/test/lte-test-carrier-aggregation-configuration.cc b/src/lte/test/lte-test-carrier-aggregation-configuration.cc index 3c89094d7..4ff49fea5 100644 --- a/src/lte/test/lte-test-carrier-aggregation-configuration.cc +++ b/src/lte/test/lte-test-carrier-aggregation-configuration.cc @@ -73,7 +73,6 @@ NS_LOG_COMPONENT_DEFINE("TestCarrierAggregationConfig"); /** * \ingroup lte-test - * \ingroup tests * * \brief Carrier aggregation configuration test case. */ @@ -388,7 +387,6 @@ CarrierAggregationConfigTestCase::DoRun() /** * \ingroup lte-test - * \ingroup tests * * \brief Carrier aggregation configuration test suite. */ @@ -451,4 +449,8 @@ CarrierAggregationConfigTestSuite::CarrierAggregationConfigTestSuite() TestCase::QUICK); } +/** + * \ingroup lte-test + * Static variable for test initialization + */ static CarrierAggregationConfigTestSuite g_carrierAggregationConfigTestSuite; diff --git a/src/lte/test/lte-test-carrier-aggregation.cc b/src/lte/test/lte-test-carrier-aggregation.cc index e2ee71c8b..33b42700b 100644 --- a/src/lte/test/lte-test-carrier-aggregation.cc +++ b/src/lte/test/lte-test-carrier-aggregation.cc @@ -255,6 +255,10 @@ TestCarrierAggregationSuite::TestCarrierAggregationSuite() } } +/** + * \ingroup lte-test + * Static variable for test initialization + */ static TestCarrierAggregationSuite lenaTestRrFfMacSchedulerSuite; std::string diff --git a/src/lte/test/lte-test-carrier-aggregation.h b/src/lte/test/lte-test-carrier-aggregation.h index 765288999..0cb21adf1 100644 --- a/src/lte/test/lte-test-carrier-aggregation.h +++ b/src/lte/test/lte-test-carrier-aggregation.h @@ -30,8 +30,7 @@ using namespace ns3; /** - * \ingroup wifi-test - * \ingroup tests wifi-test wifi module tests + * \ingroup lte-test * * \brief This system test program creates different test cases with a single eNB and * several UEs, all having the same Radio Bearer specification. In each test @@ -118,8 +117,7 @@ class CarrierAggregationTestCase : public TestCase }; /** - * \ingroup wifi-test - * \ingroup tests + * \ingroup lte-test * * \brief Test Carrier Aggregation Suite */ diff --git a/src/lte/test/lte-test-cell-selection.cc b/src/lte/test/lte-test-cell-selection.cc index 5c686354b..e993e33ab 100644 --- a/src/lte/test/lte-test-cell-selection.cc +++ b/src/lte/test/lte-test-cell-selection.cc @@ -96,6 +96,10 @@ LteCellSelectionTestSuite::LteCellSelectionTestSuite() } // end of LteCellSelectionTestSuite::LteCellSelectionTestSuite () +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LteCellSelectionTestSuite g_lteCellSelectionTestSuite; /* diff --git a/src/lte/test/lte-test-cqa-ff-mac-scheduler.cc b/src/lte/test/lte-test-cqa-ff-mac-scheduler.cc index 8d709bbd2..40684fa23 100644 --- a/src/lte/test/lte-test-cqa-ff-mac-scheduler.cc +++ b/src/lte/test/lte-test-cqa-ff-mac-scheduler.cc @@ -260,6 +260,10 @@ LenaTestCqaFfMacSchedulerSuite::LenaTestCqaFfMacSchedulerSuite() TestCase::QUICK); } +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LenaTestCqaFfMacSchedulerSuite lenaTestCqaFfMacSchedulerSuite; // --------------- T E S T - C A S E # 1 ------------------------------ diff --git a/src/lte/test/lte-test-cqa-ff-mac-scheduler.h b/src/lte/test/lte-test-cqa-ff-mac-scheduler.h index 4d365cd34..9dfd281b1 100644 --- a/src/lte/test/lte-test-cqa-ff-mac-scheduler.h +++ b/src/lte/test/lte-test-cqa-ff-mac-scheduler.h @@ -31,7 +31,6 @@ using namespace ns3; /** * \ingroup lte-test - * \ingroup tests * * \brief This is a system test program. The test is based on a scenario with single eNB and several * UEs. The goal of the test is validating if the obtained throughput performance is consistent with @@ -82,7 +81,6 @@ class LenaCqaFfMacSchedulerTestCase1 : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief This is a system test program. The test is based on a scenario with single eNB and several * UEs. The goal of the test is validating if the obtained throughput performance is consistent with @@ -128,7 +126,6 @@ class LenaCqaFfMacSchedulerTestCase2 : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief The test suite for testing CQA scheduler functionality */ diff --git a/src/lte/test/lte-test-cqi-generation.cc b/src/lte/test/lte-test-cqi-generation.cc index 97dc4f319..e3946eb3a 100644 --- a/src/lte/test/lte-test-cqi-generation.cc +++ b/src/lte/test/lte-test-cqi-generation.cc @@ -144,6 +144,10 @@ LteCqiGenerationTestSuite::LteCqiGenerationTestSuite() TestCase::QUICK); } +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LteCqiGenerationTestSuite lteCqiGenerationTestSuite; LteCqiGenerationTestCase::LteCqiGenerationTestCase(std::string name, diff --git a/src/lte/test/lte-test-cqi-generation.h b/src/lte/test/lte-test-cqi-generation.h index 5e7c3e9f3..803ff14f8 100644 --- a/src/lte/test/lte-test-cqi-generation.h +++ b/src/lte/test/lte-test-cqi-generation.h @@ -28,7 +28,6 @@ using namespace ns3; /** * \ingroup lte-test - * \ingroup tests * * \brief Lte Cqi Generation Test Suite */ @@ -41,7 +40,6 @@ class LteCqiGenerationTestSuite : public TestSuite /** * \ingroup lte-test - * \ingroup tests * * \brief This is the test case for testing different configuration of CQI generation. * The topology consists of the two UEs and two eNbs. UEs have the same position, @@ -97,7 +95,6 @@ class LteCqiGenerationTestCase : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief This test is very similar to LteCqiGenerationTestCase. The difference is that in this * test is enabled the downlink power control. diff --git a/src/lte/test/lte-test-deactivate-bearer.cc b/src/lte/test/lte-test-deactivate-bearer.cc index 8ac0b5c00..b9e849808 100644 --- a/src/lte/test/lte-test-deactivate-bearer.cc +++ b/src/lte/test/lte-test-deactivate-bearer.cc @@ -97,7 +97,11 @@ LenaTestBearerDeactivateSuite::LenaTestBearerDeactivateSuite() TestCase::QUICK); } -static LenaTestBearerDeactivateSuite lenaTestBearerDeactivateSuite; ///< the test suite +/** + * \ingroup lte-test + * Static variable for test initialization + */ +static LenaTestBearerDeactivateSuite lenaTestBearerDeactivateSuite; std::string LenaDeactivateBearerTestCase::BuildNameString(uint16_t nUser, std::vector dist) diff --git a/src/lte/test/lte-test-deactivate-bearer.h b/src/lte/test/lte-test-deactivate-bearer.h index 4a88d518f..9ff586fea 100644 --- a/src/lte/test/lte-test-deactivate-bearer.h +++ b/src/lte/test/lte-test-deactivate-bearer.h @@ -10,7 +10,6 @@ namespace ns3 /** * \ingroup lte-test - * \ingroup tests * * \brief Test case that for testing the deactivation of the bearer * functionality. The test consist in deactivating the bearer and checking @@ -62,7 +61,6 @@ class LenaDeactivateBearerTestCase : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief The test suite class for the LenaDeactivateBearerTestCase. */ diff --git a/src/lte/test/lte-test-downlink-power-control.cc b/src/lte/test/lte-test-downlink-power-control.cc index a8296a931..46832ac3d 100644 --- a/src/lte/test/lte-test-downlink-power-control.cc +++ b/src/lte/test/lte-test-downlink-power-control.cc @@ -386,6 +386,10 @@ LteDownlinkPowerControlTestSuite::CalculateRbTxPower(double txPower, uint8_t pa) return rbTxpower; } +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LteDownlinkPowerControlTestSuite lteDownlinkPowerControlTestSuite; /** diff --git a/src/lte/test/lte-test-downlink-power-control.h b/src/lte/test/lte-test-downlink-power-control.h index a909d98f4..99acb73bf 100644 --- a/src/lte/test/lte-test-downlink-power-control.h +++ b/src/lte/test/lte-test-downlink-power-control.h @@ -31,7 +31,6 @@ using namespace ns3; /** * \ingroup lte-test - * \ingroup tests * * \brief Test suite for the LteDownlinkPowerControlSpectrumValueTestCase. * @@ -52,7 +51,6 @@ class LteDownlinkPowerControlTestSuite : public TestSuite /** * \ingroup lte-test - * \ingroup tests * * \brief Test SINR calculation in the downlink when power control is used. * Test if the difference in power levels are corresponding to the estamated values. @@ -88,7 +86,6 @@ class LteDownlinkPowerControlSpectrumValueTestCase : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Test SINR calculation in the downlink when the power control is used. * Test the power control by comparing the downlink data and ctrl power @@ -117,7 +114,6 @@ class LteDownlinkPowerControlTestCase : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Test if RRC connection reconfiguration messages are properly * generated upon the change in the downlink power. diff --git a/src/lte/test/lte-test-downlink-sinr.cc b/src/lte/test/lte-test-downlink-sinr.cc index 5d95f14e2..2221bde6c 100644 --- a/src/lte/test/lte-test-downlink-sinr.cc +++ b/src/lte/test/lte-test-downlink-sinr.cc @@ -103,6 +103,10 @@ LteDownlinkSinrTestSuite::LteDownlinkSinrTestSuite() TestCase::QUICK); } +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LteDownlinkSinrTestSuite lteDownlinkSinrTestSuite; /** diff --git a/src/lte/test/lte-test-downlink-sinr.h b/src/lte/test/lte-test-downlink-sinr.h index 7f17cdfff..b1081d603 100644 --- a/src/lte/test/lte-test-downlink-sinr.h +++ b/src/lte/test/lte-test-downlink-sinr.h @@ -29,7 +29,6 @@ using namespace ns3; /** * \ingroup lte-test - * \ingroup tests * * \brief Test 1.1 SINR calculation in downlink */ @@ -41,7 +40,6 @@ class LteDownlinkSinrTestSuite : public TestSuite /** * \ingroup lte-test - * \ingroup tests * * \brief Test compares if the generated SINR is equal to estimated SINR * value. Test generates several calls to LteSpectrumPhy::StartRx corresponding @@ -73,7 +71,6 @@ class LteDownlinkDataSinrTestCase : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief * Test compares if the generated SINR is equal to estimated SINR value. diff --git a/src/lte/test/lte-test-earfcn.cc b/src/lte/test/lte-test-earfcn.cc index 9ff1a87cd..28c1730d6 100644 --- a/src/lte/test/lte-test-earfcn.cc +++ b/src/lte/test/lte-test-earfcn.cc @@ -27,7 +27,6 @@ NS_LOG_COMPONENT_DEFINE("LteTestEarfcn"); /** * \ingroup lte-test - * \ingroup tests * * \brief Test case that is testing if the frequency is properly generated * from provided EARFCN frequency. @@ -75,7 +74,6 @@ LteEarfcnTestCase::DoRun() /** * \ingroup lte-test - * \ingroup tests * * \brief * Test case that is testing if the downlink frequency is properly @@ -116,7 +114,6 @@ LteEarfcnDlTestCase::DoRun() /** * \ingroup lte-test - * \ingroup tests * * \brief Test case that is testing if the uplink frequency is properly * converted from provided uplink EARFCN frequency value. @@ -152,7 +149,6 @@ LteEarfcnUlTestCase::DoRun() /** * \ingroup lte-test - * \ingroup tests * * \brief Test suite for testing correct conversion of frequencies in * the downlink and the uplink, and general EARFCN frequencies. @@ -163,6 +159,10 @@ class LteEarfcnTestSuite : public TestSuite LteEarfcnTestSuite(); }; +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LteEarfcnTestSuite g_lteEarfcnTestSuite; LteEarfcnTestSuite::LteEarfcnTestSuite() diff --git a/src/lte/test/lte-test-entities.h b/src/lte/test/lte-test-entities.h index a2f2734d1..b90f7907a 100644 --- a/src/lte/test/lte-test-entities.h +++ b/src/lte/test/lte-test-entities.h @@ -33,7 +33,6 @@ namespace ns3 /** * \ingroup lte-test - * \ingroup tests * * \brief This class implements a testing RRC entity */ @@ -166,7 +165,6 @@ class LteTestRrc : public Object /** * \ingroup lte-test - * \ingroup tests * * \brief This class implements a testing PDCP entity */ @@ -229,7 +227,6 @@ class LteTestPdcp : public Object /** * \ingroup lte-test - * \ingroup tests * * \brief This class implements a testing loopback MAC layer */ @@ -404,7 +401,6 @@ class LteTestMac : public Object /** * \ingroup lte-test - * \ingroup tests * * \brief RRC stub providing a testing S1 SAP user to be used with the EpcEnbApplication */ diff --git a/src/lte/test/lte-test-fdbet-ff-mac-scheduler.cc b/src/lte/test/lte-test-fdbet-ff-mac-scheduler.cc index a0965bc10..5421812aa 100644 --- a/src/lte/test/lte-test-fdbet-ff-mac-scheduler.cc +++ b/src/lte/test/lte-test-fdbet-ff-mac-scheduler.cc @@ -194,6 +194,10 @@ LenaTestFdBetFfMacSchedulerSuite::LenaTestFdBetFfMacSchedulerSuite() TestCase::QUICK); } +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LenaTestFdBetFfMacSchedulerSuite lenaTestFdBetFfMacSchedulerSuite; // --------------- T E S T - C A S E # 1 ------------------------------ diff --git a/src/lte/test/lte-test-fdbet-ff-mac-scheduler.h b/src/lte/test/lte-test-fdbet-ff-mac-scheduler.h index 4fc76d975..00384cda2 100644 --- a/src/lte/test/lte-test-fdbet-ff-mac-scheduler.h +++ b/src/lte/test/lte-test-fdbet-ff-mac-scheduler.h @@ -29,7 +29,6 @@ using namespace ns3; /** * \ingroup lte-test - * \ingroup tests * * \brief This system test program creates different test cases with a single eNB and * several UEs, all having the same Radio Bearer specification. In each test @@ -77,7 +76,6 @@ class LenaFdBetFfMacSchedulerTestCase1 : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Test case is simillar to the one defined in * LenaFdBetFfMacSchedulerTestCase1, with the difference that UEs are @@ -119,7 +117,6 @@ class LenaFdBetFfMacSchedulerTestCase2 : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Test suite for FDBetFfMacScheduler test case. */ diff --git a/src/lte/test/lte-test-fdmt-ff-mac-scheduler.cc b/src/lte/test/lte-test-fdmt-ff-mac-scheduler.cc index 0dec071b1..2b9131839 100644 --- a/src/lte/test/lte-test-fdmt-ff-mac-scheduler.cc +++ b/src/lte/test/lte-test-fdmt-ff-mac-scheduler.cc @@ -170,6 +170,10 @@ LenaTestFdMtFfMacSchedulerSuite::LenaTestFdMtFfMacSchedulerSuite() AddTestCase(new LenaFdMtFfMacSchedulerTestCase(1, 100000, 0, 0, errorModel), TestCase::QUICK); } +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LenaTestFdMtFfMacSchedulerSuite lenaTestFdMtFfMacSchedulerSuite; // --------------- T E S T - C A S E ------------------------------ diff --git a/src/lte/test/lte-test-fdmt-ff-mac-scheduler.h b/src/lte/test/lte-test-fdmt-ff-mac-scheduler.h index 0b020b1b9..f18583eca 100644 --- a/src/lte/test/lte-test-fdmt-ff-mac-scheduler.h +++ b/src/lte/test/lte-test-fdmt-ff-mac-scheduler.h @@ -29,7 +29,6 @@ using namespace ns3; /** * \ingroup lte-test - * \ingroup tests * * \brief This system test program creates different test cases with a single eNB and * several UEs, all having the same Radio Bearer specification. In each test @@ -77,7 +76,6 @@ class LenaFdMtFfMacSchedulerTestCase : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Test suite for LenaFdMtFfMacSchedulerTestCase test case. */ diff --git a/src/lte/test/lte-test-fdtbfq-ff-mac-scheduler.cc b/src/lte/test/lte-test-fdtbfq-ff-mac-scheduler.cc index 3aff95fbe..265035923 100644 --- a/src/lte/test/lte-test-fdtbfq-ff-mac-scheduler.cc +++ b/src/lte/test/lte-test-fdtbfq-ff-mac-scheduler.cc @@ -261,6 +261,10 @@ LenaTestFdTbfqFfMacSchedulerSuite::LenaTestFdTbfqFfMacSchedulerSuite() TestCase::QUICK); } +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LenaTestFdTbfqFfMacSchedulerSuite lenaTestFdTbfqFfMacSchedulerSuite; // --------------- T E S T - C A S E # 1 ------------------------------ diff --git a/src/lte/test/lte-test-fdtbfq-ff-mac-scheduler.h b/src/lte/test/lte-test-fdtbfq-ff-mac-scheduler.h index 979c788f4..e0959cb12 100644 --- a/src/lte/test/lte-test-fdtbfq-ff-mac-scheduler.h +++ b/src/lte/test/lte-test-fdtbfq-ff-mac-scheduler.h @@ -29,7 +29,6 @@ using namespace ns3; /** * \ingroup lte-test - * \ingroup tests * * \brief This system test program creates different test cases with a single eNB and * several UEs, all having the same Radio Bearer specification. In each test @@ -83,7 +82,6 @@ class LenaFdTbfqFfMacSchedulerTestCase1 : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Test case is simillar to the one defined in * LenaFdTbfqFfMacSchedulerTestCase1, with the difference that UEs are @@ -128,7 +126,6 @@ class LenaFdTbfqFfMacSchedulerTestCase2 : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Test suit for FdTbfqFfMacScheduler test. */ diff --git a/src/lte/test/lte-test-frequency-reuse.cc b/src/lte/test/lte-test-frequency-reuse.cc index a5691ff29..cc96b9cfa 100644 --- a/src/lte/test/lte-test-frequency-reuse.cc +++ b/src/lte/test/lte-test-frequency-reuse.cc @@ -433,6 +433,10 @@ LteFrequencyReuseTestSuite::LteFrequencyReuseTestSuite() TestCase::QUICK); } +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LteFrequencyReuseTestSuite lteFrequencyReuseTestSuite; /** diff --git a/src/lte/test/lte-test-frequency-reuse.h b/src/lte/test/lte-test-frequency-reuse.h index 577a35151..b63618370 100644 --- a/src/lte/test/lte-test-frequency-reuse.h +++ b/src/lte/test/lte-test-frequency-reuse.h @@ -37,7 +37,6 @@ using namespace ns3; /** * \ingroup lte-test - * \ingroup tests * * \brief Test the fractional frequency reuse algorithms. */ @@ -49,7 +48,6 @@ class LteFrequencyReuseTestSuite : public TestSuite /** * \ingroup lte-test - * \ingroup tests * * \brief Test frequency reuse algorithm. Test fails if the muted frequencies * are being used. @@ -102,7 +100,6 @@ class LteFrTestCase : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Test hard frequency reuse algorithm. Test fails if the muted * frequencies are being used. @@ -152,7 +149,6 @@ class LteHardFrTestCase : public LteFrTestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Test stric frequency reuse algorithm. Test fails if the muted frequencies * are being used. @@ -208,7 +204,6 @@ class LteStrictFrTestCase : public LteFrTestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Test frequency reuse algorithm by teleporing UEs to different * parts of area and checking if the frequency is used according to the @@ -303,7 +298,6 @@ class LteFrAreaTestCase : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Lte Fr Area Test Case */ @@ -325,7 +319,6 @@ class LteStrictFrAreaTestCase : public LteFrAreaTestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Lte Soft Fr Area Test Case */ @@ -347,7 +340,6 @@ class LteSoftFrAreaTestCase : public LteFrAreaTestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Lte Soft Ffr Area Test Case */ @@ -369,7 +361,6 @@ class LteSoftFfrAreaTestCase : public LteFrAreaTestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Lte Enhanced Ffr Area Test Case */ @@ -391,7 +382,6 @@ class LteEnhancedFfrAreaTestCase : public LteFrAreaTestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Lte Distributed Ffr Area Test Case */ diff --git a/src/lte/test/lte-test-harq.cc b/src/lte/test/lte-test-harq.cc index cfcc69be6..b6d7b0ead 100644 --- a/src/lte/test/lte-test-harq.cc +++ b/src/lte/test/lte-test-harq.cc @@ -73,6 +73,10 @@ LenaTestHarqSuite::LenaTestHarqSuite() AddTestCase(new LenaHarqTestCase(1, 770, 472, 0.06, 209964), TestCase::QUICK); } +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LenaTestHarqSuite lenaTestHarqSuite; std::string diff --git a/src/lte/test/lte-test-harq.h b/src/lte/test/lte-test-harq.h index 7cd59342d..c7c3f06f1 100644 --- a/src/lte/test/lte-test-harq.h +++ b/src/lte/test/lte-test-harq.h @@ -27,7 +27,6 @@ using namespace ns3; /** * \ingroup lte-test - * \ingroup tests * * \brief This system test program creates different test cases with a single eNB and * several UEs, all having the same Radio Bearer specification. In each test @@ -69,7 +68,6 @@ class LenaHarqTestCase : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Test suite for harq test. */ diff --git a/src/lte/test/lte-test-interference-fr.cc b/src/lte/test/lte-test-interference-fr.cc index 1ca603887..aecb9779b 100644 --- a/src/lte/test/lte-test-interference-fr.cc +++ b/src/lte/test/lte-test-interference-fr.cc @@ -119,6 +119,10 @@ LteInterferenceFrTestSuite::LteInterferenceFrTestSuite() TestCase::QUICK); } +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LteInterferenceFrTestSuite LteInterferenceFrTestSuite; /** diff --git a/src/lte/test/lte-test-interference-fr.h b/src/lte/test/lte-test-interference-fr.h index f59f50acb..ff9c6892d 100644 --- a/src/lte/test/lte-test-interference-fr.h +++ b/src/lte/test/lte-test-interference-fr.h @@ -29,7 +29,6 @@ using namespace ns3; /** * \ingroup lte-test - * \ingroup tests * * \brief Test suite for the interference test when using different * frequency reuse algorithms.Check if the interfence values correspond to @@ -43,7 +42,6 @@ class LteInterferenceFrTestSuite : public TestSuite /** * \ingroup lte-test - * \ingroup tests * * \brief Lte interference test when using hard frequency reuse algorithm. Check * if the interfence values correspond to theoretical values. @@ -77,7 +75,6 @@ class LteInterferenceHardFrTestCase : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Lte interference test when using strict frequency reuse algorithm. */ diff --git a/src/lte/test/lte-test-interference.cc b/src/lte/test/lte-test-interference.cc index d0ce8193b..33162e416 100644 --- a/src/lte/test/lte-test-interference.cc +++ b/src/lte/test/lte-test-interference.cc @@ -187,6 +187,10 @@ LteInterferenceTestSuite::LteInterferenceTestSuite() TestCase::QUICK); } +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LteInterferenceTestSuite lteLinkAdaptationWithInterferenceTestSuite; /** diff --git a/src/lte/test/lte-test-interference.h b/src/lte/test/lte-test-interference.h index a41d6b5f7..4a0720031 100644 --- a/src/lte/test/lte-test-interference.h +++ b/src/lte/test/lte-test-interference.h @@ -28,7 +28,6 @@ using namespace ns3; /** * \ingroup lte-test - * \ingroup tests * * \brief Test suite for interference test. */ @@ -40,7 +39,6 @@ class LteInterferenceTestSuite : public TestSuite /** * \ingroup lte-test - * \ingroup tests * * \brief Test that SINR calculation and MCS selection works fine in a * multi-cell interference scenario. diff --git a/src/lte/test/lte-test-ipv6-routing.cc b/src/lte/test/lte-test-ipv6-routing.cc index 995499206..f6ab82189 100644 --- a/src/lte/test/lte-test-ipv6-routing.cc +++ b/src/lte/test/lte-test-ipv6-routing.cc @@ -51,7 +51,6 @@ using namespace ns3; /** * \ingroup lte-test - * \ingroup tests * * \brief Lte Ipv6 routing test case. */ @@ -396,4 +395,8 @@ LteIpv6RoutingTestSuite::LteIpv6RoutingTestSuite() AddTestCase(new LteIpv6RoutingTestCase, TestCase::QUICK); } -static LteIpv6RoutingTestSuite lteipv6testsuite; +/** + * \ingroup lte-test + * Static variable for test initialization + */ +static LteIpv6RoutingTestSuite g_lteipv6testsuite; diff --git a/src/lte/test/lte-test-link-adaptation.cc b/src/lte/test/lte-test-link-adaptation.cc index fffb3a483..75fa7d2d3 100644 --- a/src/lte/test/lte-test-link-adaptation.cc +++ b/src/lte/test/lte-test-link-adaptation.cc @@ -105,6 +105,10 @@ LteLinkAdaptationTestSuite::LteLinkAdaptationTestSuite() } } +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LteLinkAdaptationTestSuite lteLinkAdaptationTestSuite; /** diff --git a/src/lte/test/lte-test-link-adaptation.h b/src/lte/test/lte-test-link-adaptation.h index 9edd3ac53..5f073e0c0 100644 --- a/src/lte/test/lte-test-link-adaptation.h +++ b/src/lte/test/lte-test-link-adaptation.h @@ -27,7 +27,6 @@ using namespace ns3; /** * \ingroup lte-test - * \ingroup tests * * \brief Test 1.3 Link adaptation */ @@ -39,7 +38,6 @@ class LteLinkAdaptationTestSuite : public TestSuite /** * \ingroup lte-test - * \ingroup tests * * \brief Test that LTE link adaptation works according to the theoretical model. */ diff --git a/src/lte/test/lte-test-mimo.cc b/src/lte/test/lte-test-mimo.cc index 8ac10c09c..1e3934461 100644 --- a/src/lte/test/lte-test-mimo.cc +++ b/src/lte/test/lte-test-mimo.cc @@ -81,6 +81,10 @@ LenaTestMimoSuite::LenaTestMimoSuite() TestCase::QUICK); } +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LenaTestMimoSuite lenaTestMimoSuite; std::string diff --git a/src/lte/test/lte-test-mimo.h b/src/lte/test/lte-test-mimo.h index 12e84375d..c0e5162da 100644 --- a/src/lte/test/lte-test-mimo.h +++ b/src/lte/test/lte-test-mimo.h @@ -32,7 +32,6 @@ using namespace ns3; /** * \ingroup lte-test - * \ingroup tests * * \brief This system test program creates different test cases with a * single eNB and single UE. The traffic is configured to be in saturation @@ -85,7 +84,6 @@ class LenaMimoTestCase : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Lena Test Mimo Suite */ diff --git a/src/lte/test/lte-test-pathloss-model.cc b/src/lte/test/lte-test-pathloss-model.cc index ae9d24a36..425e32f7c 100644 --- a/src/lte/test/lte-test-pathloss-model.cc +++ b/src/lte/test/lte-test-pathloss-model.cc @@ -141,6 +141,10 @@ LtePathlossModelTestSuite::LtePathlossModelTestSuite() } } +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LtePathlossModelTestSuite ltePathlossModelTestSuite; LtePathlossModelSystemTestCase::LtePathlossModelSystemTestCase(std::string name, diff --git a/src/lte/test/lte-test-pathloss-model.h b/src/lte/test/lte-test-pathloss-model.h index b3003884e..6b83040f8 100644 --- a/src/lte/test/lte-test-pathloss-model.h +++ b/src/lte/test/lte-test-pathloss-model.h @@ -29,7 +29,6 @@ using namespace ns3; /** * \ingroup lte-test - * \ingroup tests * * \brief Test 1.1 pathloss calculation */ @@ -41,7 +40,6 @@ class LtePathlossModelTestSuite : public TestSuite /** * \ingroup lte-test - * \ingroup tests * * \brief Tests that the BuildingPathlossModel works according to * the expected theoretical values. Theoretical reference values diff --git a/src/lte/test/lte-test-pf-ff-mac-scheduler.cc b/src/lte/test/lte-test-pf-ff-mac-scheduler.cc index ba3b8f916..bc02ce263 100644 --- a/src/lte/test/lte-test-pf-ff-mac-scheduler.cc +++ b/src/lte/test/lte-test-pf-ff-mac-scheduler.cc @@ -211,6 +211,10 @@ LenaTestPfFfMacSchedulerSuite::LenaTestPfFfMacSchedulerSuite() TestCase::QUICK); } +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LenaTestPfFfMacSchedulerSuite lenaTestPfFfMacSchedulerSuite; // --------------- T E S T - C A S E # 1 ------------------------------ diff --git a/src/lte/test/lte-test-pf-ff-mac-scheduler.h b/src/lte/test/lte-test-pf-ff-mac-scheduler.h index f86f3a295..39034abd0 100644 --- a/src/lte/test/lte-test-pf-ff-mac-scheduler.h +++ b/src/lte/test/lte-test-pf-ff-mac-scheduler.h @@ -28,7 +28,6 @@ using namespace ns3; /** * \ingroup lte-test - * \ingroup tests * * \brief This system test program creates different test cases with a single eNB and * several UEs, all having the same Radio Bearer specification. In each test @@ -75,7 +74,6 @@ class LenaPfFfMacSchedulerTestCase1 : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Lena PfFf Mac Scheduler Test Case 2 */ @@ -114,7 +112,6 @@ class LenaPfFfMacSchedulerTestCase2 : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief PfFfMacScheduler test suite */ diff --git a/src/lte/test/lte-test-phy-error-model.cc b/src/lte/test/lte-test-phy-error-model.cc index cede73375..2c4b96f3e 100644 --- a/src/lte/test/lte-test-phy-error-model.cc +++ b/src/lte/test/lte-test-phy-error-model.cc @@ -114,6 +114,10 @@ LenaTestPhyErrorModelSuite::LenaTestPhyErrorModelSuite() } } +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LenaTestPhyErrorModelSuite lenaTestPhyErrorModelSuite; std::string diff --git a/src/lte/test/lte-test-phy-error-model.h b/src/lte/test/lte-test-phy-error-model.h index 4b194b668..5c964e5a3 100644 --- a/src/lte/test/lte-test-phy-error-model.h +++ b/src/lte/test/lte-test-phy-error-model.h @@ -28,7 +28,6 @@ using namespace ns3; /** * \ingroup lte-test - * \ingroup tests * * \brief This system test program creates different test cases with a single eNB and * several UEs, all having the same Radio Bearer specification. In each test @@ -78,7 +77,6 @@ class LenaDataPhyErrorModelTestCase : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Lena Dl Ctrl Phy Error Model Test Case */ @@ -124,7 +122,6 @@ class LenaDlCtrlPhyErrorModelTestCase : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Lena Test Phy Error Model Suite */ diff --git a/src/lte/test/lte-test-primary-cell-change.cc b/src/lte/test/lte-test-primary-cell-change.cc index 16bb0d9fa..775a71f73 100644 --- a/src/lte/test/lte-test-primary-cell-change.cc +++ b/src/lte/test/lte-test-primary-cell-change.cc @@ -96,6 +96,10 @@ LtePrimaryCellChangeTestSuite::LtePrimaryCellChangeTestSuite() TestCase::QUICK); } // end of LtePrimaryCellChangeTestSuite::LtePrimaryCellChangeTestSuite () +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LtePrimaryCellChangeTestSuite g_ltePrimaryCellChangeTestSuite; /* diff --git a/src/lte/test/lte-test-pss-ff-mac-scheduler.cc b/src/lte/test/lte-test-pss-ff-mac-scheduler.cc index 144ec4214..993e04ae6 100644 --- a/src/lte/test/lte-test-pss-ff-mac-scheduler.cc +++ b/src/lte/test/lte-test-pss-ff-mac-scheduler.cc @@ -258,6 +258,10 @@ LenaTestPssFfMacSchedulerSuite::LenaTestPssFfMacSchedulerSuite() TestCase::QUICK); } +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LenaTestPssFfMacSchedulerSuite lenaTestPssFfMacSchedulerSuite; // --------------- T E S T - C A S E # 1 ------------------------------ diff --git a/src/lte/test/lte-test-pss-ff-mac-scheduler.h b/src/lte/test/lte-test-pss-ff-mac-scheduler.h index 24e7c979c..6af705641 100644 --- a/src/lte/test/lte-test-pss-ff-mac-scheduler.h +++ b/src/lte/test/lte-test-pss-ff-mac-scheduler.h @@ -29,7 +29,6 @@ using namespace ns3; /** * \ingroup lte-test - * \ingroup tests * * \brief This system test program creates different test cases with a single eNB and * several UEs, all having the same Radio Bearer specification. In each test @@ -82,7 +81,6 @@ class LenaPssFfMacSchedulerTestCase1 : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Simillar to the LenaPssFfMacSchedulerTestCase1 with the difference that * UEs are places in such a way to experience different SINRs. Test checks if the @@ -126,7 +124,6 @@ class LenaPssFfMacSchedulerTestCase2 : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Lena Pss Ff Mac Scheduler Test Suite */ diff --git a/src/lte/test/lte-test-radio-link-failure.cc b/src/lte/test/lte-test-radio-link-failure.cc index 40af3a776..1bd902697 100644 --- a/src/lte/test/lte-test-radio-link-failure.cc +++ b/src/lte/test/lte-test-radio-link-failure.cc @@ -115,6 +115,10 @@ LteRadioLinkFailureTestSuite::LteRadioLinkFailureTestSuite() } // end of LteRadioLinkFailureTestSuite::LteRadioLinkFailureTestSuite () +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LteRadioLinkFailureTestSuite g_lteRadioLinkFailureTestSuite; /* diff --git a/src/lte/test/lte-test-rlc-am-e2e.cc b/src/lte/test/lte-test-rlc-am-e2e.cc index 0251b353a..191e5b419 100644 --- a/src/lte/test/lte-test-rlc-am-e2e.cc +++ b/src/lte/test/lte-test-rlc-am-e2e.cc @@ -98,6 +98,10 @@ LteRlcAmE2eTestSuite::LteRlcAmE2eTestSuite() } } +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LteRlcAmE2eTestSuite lteRlcAmE2eTestSuite; LteRlcAmE2eTestCase::LteRlcAmE2eTestCase(std::string name, diff --git a/src/lte/test/lte-test-rlc-am-e2e.h b/src/lte/test/lte-test-rlc-am-e2e.h index 71c99d028..a08046961 100644 --- a/src/lte/test/lte-test-rlc-am-e2e.h +++ b/src/lte/test/lte-test-rlc-am-e2e.h @@ -33,7 +33,6 @@ using namespace ns3; /** * \ingroup lte-test - * \ingroup tests * * \brief Test suite for RlcAmE2e test case. */ @@ -45,7 +44,6 @@ class LteRlcAmE2eTestSuite : public TestSuite /** * \ingroup lte-test - * \ingroup tests * * Test cases used for the test suite lte-rlc-am-e2e. See the testing section of * the LTE module documentation for details. diff --git a/src/lte/test/lte-test-rlc-am-transmitter.cc b/src/lte/test/lte-test-rlc-am-transmitter.cc index c3c08fcbd..97598591b 100644 --- a/src/lte/test/lte-test-rlc-am-transmitter.cc +++ b/src/lte/test/lte-test-rlc-am-transmitter.cc @@ -47,6 +47,10 @@ LteRlcAmTransmitterTestSuite::LteRlcAmTransmitterTestSuite() TestCase::QUICK); } +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LteRlcAmTransmitterTestSuite lteRlcAmTransmitterTestSuite; LteRlcAmTransmitterTestCase::LteRlcAmTransmitterTestCase(std::string name) diff --git a/src/lte/test/lte-test-rlc-am-transmitter.h b/src/lte/test/lte-test-rlc-am-transmitter.h index 09e78e9b3..a7e6cf8b3 100644 --- a/src/lte/test/lte-test-rlc-am-transmitter.h +++ b/src/lte/test/lte-test-rlc-am-transmitter.h @@ -38,7 +38,6 @@ using namespace ns3; /** * \ingroup lte-test - * \ingroup tests * * \brief TestSuite 4.1.1 RLC AM: Only transmitter functionality. */ @@ -50,7 +49,6 @@ class LteRlcAmTransmitterTestSuite : public TestSuite /** * \ingroup lte-test - * \ingroup tests * * \brief Test case used by LteRlcAmTransmitterOneSduTestCase to create topology * and to implement functionalities and check if data received corresponds to @@ -94,7 +92,6 @@ class LteRlcAmTransmitterTestCase : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Test 4.1.1.1 Test that SDU transmitted at PDCP corresponds to PDU * received by MAC. @@ -117,7 +114,6 @@ class LteRlcAmTransmitterOneSduTestCase : public LteRlcAmTransmitterTestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Test 4.1.1.2 Test the correct functionality of the Segmentation. * Test check that single SDU is properly segmented to n PDUs. @@ -140,7 +136,6 @@ class LteRlcAmTransmitterSegmentationTestCase : public LteRlcAmTransmitterTestCa /** * \ingroup lte-test - * \ingroup tests * * \brief Test 4.1.1.3 Test that concatenation functionality works properly. * Test check if n SDUs are correctly contactenate to single PDU. @@ -163,7 +158,6 @@ class LteRlcAmTransmitterConcatenationTestCase : public LteRlcAmTransmitterTestC /** * \ingroup lte-test - * \ingroup tests * * \brief Test 4.1.1.4 Test checks functionality of Report Buffer Status by * testing primitive parameters. diff --git a/src/lte/test/lte-test-rlc-um-e2e.cc b/src/lte/test/lte-test-rlc-um-e2e.cc index c6b2f5ca7..50c10b466 100644 --- a/src/lte/test/lte-test-rlc-um-e2e.cc +++ b/src/lte/test/lte-test-rlc-um-e2e.cc @@ -75,6 +75,10 @@ LteRlcUmE2eTestSuite::LteRlcUmE2eTestSuite() } } +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LteRlcUmE2eTestSuite lteRlcUmE2eTestSuite; /** diff --git a/src/lte/test/lte-test-rlc-um-e2e.h b/src/lte/test/lte-test-rlc-um-e2e.h index cf986985a..802744ea8 100644 --- a/src/lte/test/lte-test-rlc-um-e2e.h +++ b/src/lte/test/lte-test-rlc-um-e2e.h @@ -32,7 +32,6 @@ using namespace ns3; /** * \ingroup lte-test - * \ingroup tests * * \brief Test suite for RlcUmE2eTestCase */ @@ -44,7 +43,6 @@ class LteRlcUmE2eTestSuite : public TestSuite /** * \ingroup lte-test - * \ingroup tests * * \brief Test end-to-end flow when RLC UM is being used. */ diff --git a/src/lte/test/lte-test-rlc-um-transmitter.cc b/src/lte/test/lte-test-rlc-um-transmitter.cc index 4422ce605..52a785f28 100644 --- a/src/lte/test/lte-test-rlc-um-transmitter.cc +++ b/src/lte/test/lte-test-rlc-um-transmitter.cc @@ -49,6 +49,10 @@ LteRlcUmTransmitterTestSuite::LteRlcUmTransmitterTestSuite() TestCase::QUICK); } +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LteRlcUmTransmitterTestSuite lteRlcUmTransmitterTestSuite; LteRlcUmTransmitterTestCase::LteRlcUmTransmitterTestCase(std::string name) diff --git a/src/lte/test/lte-test-rlc-um-transmitter.h b/src/lte/test/lte-test-rlc-um-transmitter.h index 856ce5891..ff3ed2340 100644 --- a/src/lte/test/lte-test-rlc-um-transmitter.h +++ b/src/lte/test/lte-test-rlc-um-transmitter.h @@ -38,7 +38,6 @@ using namespace ns3; /** * \ingroup lte-test - * \ingroup tests * * \brief TestSuite 4.1.1 for RLC UM: Only transmitter part. */ @@ -50,7 +49,6 @@ class LteRlcUmTransmitterTestSuite : public TestSuite /** * \ingroup lte-test - * \ingroup tests * * \brief Test case used by LteRlcUmTransmitterOneSduTestCase to create topology * and to implement functionalities and check if data received corresponds to @@ -94,7 +92,6 @@ class LteRlcUmTransmitterTestCase : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Test 4.1.1.1 One SDU, One PDU */ @@ -116,7 +113,6 @@ class LteRlcUmTransmitterOneSduTestCase : public LteRlcUmTransmitterTestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Test 4.1.1.2 Segmentation (One SDU => n PDUs) */ @@ -138,7 +134,6 @@ class LteRlcUmTransmitterSegmentationTestCase : public LteRlcUmTransmitterTestCa /** * \ingroup lte-test - * \ingroup tests * * \brief Test 4.1.1.3 Concatenation (n SDUs => One PDU) */ @@ -160,7 +155,6 @@ class LteRlcUmTransmitterConcatenationTestCase : public LteRlcUmTransmitterTestC /** * \ingroup lte-test - * \ingroup tests * * \brief Test 4.1.1.4 Report Buffer Status (test primitive parameters) */ diff --git a/src/lte/test/lte-test-rr-ff-mac-scheduler.cc b/src/lte/test/lte-test-rr-ff-mac-scheduler.cc index 30e6e1fc7..cdb7e11b3 100644 --- a/src/lte/test/lte-test-rr-ff-mac-scheduler.cc +++ b/src/lte/test/lte-test-rr-ff-mac-scheduler.cc @@ -176,6 +176,10 @@ LenaTestRrFfMacSchedulerSuite::LenaTestRrFfMacSchedulerSuite() AddTestCase(new LenaRrFfMacSchedulerTestCase(1, 100000, 0, 0, errorModel), TestCase::QUICK); } +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LenaTestRrFfMacSchedulerSuite lenaTestRrFfMacSchedulerSuite; std::string diff --git a/src/lte/test/lte-test-rr-ff-mac-scheduler.h b/src/lte/test/lte-test-rr-ff-mac-scheduler.h index cbe7574fb..9158ce062 100644 --- a/src/lte/test/lte-test-rr-ff-mac-scheduler.h +++ b/src/lte/test/lte-test-rr-ff-mac-scheduler.h @@ -27,7 +27,6 @@ using namespace ns3; /** * \ingroup lte-test - * \ingroup tests * * \brief This system test program creates different test cases with a single eNB and * This system test program creates different test cases with a single eNB and @@ -75,7 +74,6 @@ class LenaRrFfMacSchedulerTestCase : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Test suite for RrFfMacScheduler test */ diff --git a/src/lte/test/lte-test-secondary-cell-handover.cc b/src/lte/test/lte-test-secondary-cell-handover.cc index a80980359..48574b2de 100644 --- a/src/lte/test/lte-test-secondary-cell-handover.cc +++ b/src/lte/test/lte-test-secondary-cell-handover.cc @@ -39,7 +39,6 @@ NS_LOG_COMPONENT_DEFINE("LteSecondaryCellHandoverTest"); /** * \ingroup lte-test - * \ingroup tests * * \brief Test measurement-based handover to secondary cell. */ @@ -196,7 +195,6 @@ LteSecondaryCellHandoverTestCase::DoTeardown() /** * \ingroup lte-test - * \ingroup tests * * \brief LTE measurement-based handover to secondary cell test suite. */ @@ -213,4 +211,8 @@ LteSecondaryCellHandoverTestSuite::LteSecondaryCellHandoverTestSuite() AddTestCase(new LteSecondaryCellHandoverTestCase("Real RRC", false), TestCase::QUICK); } +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LteSecondaryCellHandoverTestSuite g_lteSecondaryCellHandoverTestSuiteInstance; diff --git a/src/lte/test/lte-test-secondary-cell-selection.cc b/src/lte/test/lte-test-secondary-cell-selection.cc index d0eac9aad..c60d05760 100644 --- a/src/lte/test/lte-test-secondary-cell-selection.cc +++ b/src/lte/test/lte-test-secondary-cell-selection.cc @@ -67,6 +67,10 @@ LteSecondaryCellSelectionTestSuite::LteSecondaryCellSelectionTestSuite() } // end of LteSecondaryCellSelectionTestSuite::LteSecondaryCellSelectionTestSuite () +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LteSecondaryCellSelectionTestSuite g_lteSecondaryCellSelectionTestSuite; /* diff --git a/src/lte/test/lte-test-spectrum-value-helper.cc b/src/lte/test/lte-test-spectrum-value-helper.cc index 1f93aebc4..fee065eb2 100644 --- a/src/lte/test/lte-test-spectrum-value-helper.cc +++ b/src/lte/test/lte-test-spectrum-value-helper.cc @@ -28,7 +28,6 @@ NS_LOG_COMPONENT_DEFINE("LteTestSpectrumValueHelper"); /** * \ingroup lte-test - * \ingroup tests * * \brief Test checks if lte spectrum model is generated properly. Different * test cases are configured by defining different frequency and banwidth. @@ -82,7 +81,6 @@ LteSpectrumModelTestCase::DoRun() /** * \ingroup lte-test - * \ingroup tests * * \brief Test that the function for creation of LTE noise power spectral * density is working properly. @@ -144,7 +142,6 @@ LteNoisePsdTestCase::DoRun() /** * \ingroup lte-test - * \ingroup tests * * \brief Test that the funtcion for the creation of the Lte transmission power * spectral density is working as expected. @@ -210,7 +207,6 @@ LteTxPsdTestCase::DoRun() /** * \ingroup lte-test - * \ingroup tests * * \brief Test suite for LteSpectrumValueHelper. Test suite is * checking different functionalities of LteSpectrumValueHelper. @@ -221,6 +217,10 @@ class LteSpectrumValueHelperTestSuite : public TestSuite LteSpectrumValueHelperTestSuite(); }; +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LteSpectrumValueHelperTestSuite g_lteSpectrumValueHelperTestSuite; LteSpectrumValueHelperTestSuite::LteSpectrumValueHelperTestSuite() diff --git a/src/lte/test/lte-test-tdbet-ff-mac-scheduler.cc b/src/lte/test/lte-test-tdbet-ff-mac-scheduler.cc index 4e12f0fca..c73c5115c 100644 --- a/src/lte/test/lte-test-tdbet-ff-mac-scheduler.cc +++ b/src/lte/test/lte-test-tdbet-ff-mac-scheduler.cc @@ -194,6 +194,10 @@ LenaTestTdBetFfMacSchedulerSuite::LenaTestTdBetFfMacSchedulerSuite() TestCase::QUICK); } +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LenaTestTdBetFfMacSchedulerSuite lenaTestTdBetFfMacSchedulerSuite; // --------------- T E S T - C A S E # 1 ------------------------------ diff --git a/src/lte/test/lte-test-tdbet-ff-mac-scheduler.h b/src/lte/test/lte-test-tdbet-ff-mac-scheduler.h index 99fbc1da1..f4b80e1da 100644 --- a/src/lte/test/lte-test-tdbet-ff-mac-scheduler.h +++ b/src/lte/test/lte-test-tdbet-ff-mac-scheduler.h @@ -29,7 +29,6 @@ using namespace ns3; /** * \ingroup lte-test - * \ingroup tests * * \brief This system test program creates different test cases with a single eNB and * several UEs, all having the same Radio Bearer specification. In each test @@ -76,7 +75,6 @@ class LenaTdBetFfMacSchedulerTestCase1 : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Lena TdBet Ff Mac Scheduler Test Case */ @@ -115,7 +113,6 @@ class LenaTdBetFfMacSchedulerTestCase2 : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Test suite for TdBetFfMacScheduler tests. */ diff --git a/src/lte/test/lte-test-tdmt-ff-mac-scheduler.cc b/src/lte/test/lte-test-tdmt-ff-mac-scheduler.cc index e84030abf..1b4d3e993 100644 --- a/src/lte/test/lte-test-tdmt-ff-mac-scheduler.cc +++ b/src/lte/test/lte-test-tdmt-ff-mac-scheduler.cc @@ -169,6 +169,10 @@ LenaTestTdMtFfMacSchedulerSuite::LenaTestTdMtFfMacSchedulerSuite() AddTestCase(new LenaTdMtFfMacSchedulerTestCase(1, 100000, 0, 0, errorModel), TestCase::QUICK); } +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LenaTestTdMtFfMacSchedulerSuite lenaTestTdMtFfMacSchedulerSuite; // --------------- T E S T - C A S E ------------------------------ diff --git a/src/lte/test/lte-test-tdmt-ff-mac-scheduler.h b/src/lte/test/lte-test-tdmt-ff-mac-scheduler.h index 2667a7352..5706bf477 100644 --- a/src/lte/test/lte-test-tdmt-ff-mac-scheduler.h +++ b/src/lte/test/lte-test-tdmt-ff-mac-scheduler.h @@ -29,7 +29,6 @@ using namespace ns3; /** * \ingroup lte-test - * \ingroup tests * * \brief This system test program creates different test cases with a single eNB and * several UEs, all having the same Radio Bearer specification. In each test @@ -76,7 +75,6 @@ class LenaTdMtFfMacSchedulerTestCase : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Test suite for TdMtFfMacScheduler tests. */ diff --git a/src/lte/test/lte-test-tdtbfq-ff-mac-scheduler.cc b/src/lte/test/lte-test-tdtbfq-ff-mac-scheduler.cc index 80e9ae57a..179f926d9 100644 --- a/src/lte/test/lte-test-tdtbfq-ff-mac-scheduler.cc +++ b/src/lte/test/lte-test-tdtbfq-ff-mac-scheduler.cc @@ -261,6 +261,10 @@ LenaTestTdTbfqFfMacSchedulerSuite::LenaTestTdTbfqFfMacSchedulerSuite() TestCase::QUICK); } +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LenaTestTdTbfqFfMacSchedulerSuite lenaTestTdTbfqFfMacSchedulerSuite; // --------------- T E S T - C A S E # 1 ------------------------------ diff --git a/src/lte/test/lte-test-tdtbfq-ff-mac-scheduler.h b/src/lte/test/lte-test-tdtbfq-ff-mac-scheduler.h index 9eac776de..fd5d1131e 100644 --- a/src/lte/test/lte-test-tdtbfq-ff-mac-scheduler.h +++ b/src/lte/test/lte-test-tdtbfq-ff-mac-scheduler.h @@ -29,7 +29,6 @@ using namespace ns3; /** * \ingroup lte-test - * \ingroup tests * * \brief This system test program creates different test cases with a single eNB and * several UEs, all having the same Radio Bearer specification. In each test @@ -82,7 +81,6 @@ class LenaTdTbfqFfMacSchedulerTestCase1 : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Lena TdTbfq Ff Mac Scheduler Test Case 2 */ @@ -124,7 +122,6 @@ class LenaTdTbfqFfMacSchedulerTestCase2 : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Test suite for TdTbfqFfMacScheduler test. */ diff --git a/src/lte/test/lte-test-tta-ff-mac-scheduler.cc b/src/lte/test/lte-test-tta-ff-mac-scheduler.cc index 25968e5f7..12c4d2a30 100644 --- a/src/lte/test/lte-test-tta-ff-mac-scheduler.cc +++ b/src/lte/test/lte-test-tta-ff-mac-scheduler.cc @@ -169,6 +169,10 @@ LenaTestTtaFfMacSchedulerSuite::LenaTestTtaFfMacSchedulerSuite() AddTestCase(new LenaTtaFfMacSchedulerTestCase(1, 100000, 0, 0, errorModel), TestCase::QUICK); } +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LenaTestTtaFfMacSchedulerSuite lenaTestTtaFfMacSchedulerSuite; // --------------- T E S T - C A S E ------------------------------ diff --git a/src/lte/test/lte-test-tta-ff-mac-scheduler.h b/src/lte/test/lte-test-tta-ff-mac-scheduler.h index f537026b8..09c738383 100644 --- a/src/lte/test/lte-test-tta-ff-mac-scheduler.h +++ b/src/lte/test/lte-test-tta-ff-mac-scheduler.h @@ -29,7 +29,6 @@ using namespace ns3; /** * \ingroup lte-test - * \ingroup tests * * \brief This system test program creates different test cases with a single eNB and * several UEs, all having the same Radio Bearer specification. In each test @@ -76,7 +75,6 @@ class LenaTtaFfMacSchedulerTestCase : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Lena Test Tta Ff Mac Scheduler Suite */ diff --git a/src/lte/test/lte-test-ue-measurements.cc b/src/lte/test/lte-test-ue-measurements.cc index 54ed02104..08182146f 100644 --- a/src/lte/test/lte-test-ue-measurements.cc +++ b/src/lte/test/lte-test-ue-measurements.cc @@ -232,6 +232,10 @@ LteUeMeasurementsTestSuite::LteUeMeasurementsTestSuite() TestCase::EXTENSIVE); } +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LteUeMeasurementsTestSuite lteUeMeasurementsTestSuite; /* @@ -693,6 +697,10 @@ LteUeMeasurementsPiecewiseTestSuite1::LteUeMeasurementsPiecewiseTestSuite1() } // end of LteUeMeasurementsPiecewiseTestSuite1::LteUeMeasurementsPiecewiseTestSuite1 +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LteUeMeasurementsPiecewiseTestSuite1 lteUeMeasurementsPiecewiseTestSuite1; /* @@ -1392,6 +1400,10 @@ LteUeMeasurementsPiecewiseTestSuite2::LteUeMeasurementsPiecewiseTestSuite2() } // end of LteUeMeasurementsPiecewiseTestSuite2::LteUeMeasurementsPiecewiseTestSuite2 +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LteUeMeasurementsPiecewiseTestSuite2 lteUeMeasurementsPiecewiseTestSuite2; /* @@ -1716,6 +1728,10 @@ LteUeMeasurementsPiecewiseTestSuite3::LteUeMeasurementsPiecewiseTestSuite3() TestCase::QUICK); } // end of LteUeMeasurementsPiecewiseTestSuite3::LteUeMeasurementsPiecewiseTestSuite3 +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LteUeMeasurementsPiecewiseTestSuite3 lteUeMeasurementsPiecewiseTestSuite3; /* @@ -2264,6 +2280,10 @@ LteUeMeasurementsHandoverTestSuite::LteUeMeasurementsHandoverTestSuite() } // end of LteUeMeasurementsHandoverTestSuite::LteUeMeasurementsHandoverTestSuite +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LteUeMeasurementsHandoverTestSuite lteUeMeasurementsHandoverTestSuite; /* diff --git a/src/lte/test/lte-test-ue-measurements.h b/src/lte/test/lte-test-ue-measurements.h index b6020f866..9be4e15fc 100644 --- a/src/lte/test/lte-test-ue-measurements.h +++ b/src/lte/test/lte-test-ue-measurements.h @@ -45,7 +45,6 @@ using namespace ns3; /** * \ingroup lte-test - * \ingroup tests * * \brief Test that UE Measurements (see 36.214) calculation works fine in a * multi-cell interference scenario. @@ -58,7 +57,6 @@ class LteUeMeasurementsTestSuite : public TestSuite /** * \ingroup lte-test - * \ingroup tests * * \brief Test that UE measurements calculation works properly in a scenario * with 2 eNodeBs and 2UEs. Test that RSRP and RSRQ of the serving cell and of @@ -128,7 +126,6 @@ class LteUeMeasurementsTestCase : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Test suite for generating calls to UE measurements test case * ns3::LteUeMeasurementsPiecewiseTestCase1. @@ -141,7 +138,6 @@ class LteUeMeasurementsPiecewiseTestSuite1 : public TestSuite /** * \ingroup lte-test - * \ingroup tests * * \brief Testing UE measurements in LTE with simulation of 1 eNodeB and 1 UE in * piecewise configuration and 120 ms report interval. During the simulation @@ -265,7 +261,6 @@ class LteUeMeasurementsPiecewiseTestCase1 : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Test suite for generating calls to UE measurements test case * ns3::LteUeMeasurementsPiecewiseTestCase2. @@ -278,7 +273,6 @@ class LteUeMeasurementsPiecewiseTestSuite2 : public TestSuite /** * \ingroup lte-test - * \ingroup tests * * \brief Testing UE measurements in LTE with simulation of 2 eNodeB and 1 UE in * piecewise configuration and 240 ms report interval. @@ -402,7 +396,6 @@ class LteUeMeasurementsPiecewiseTestCase2 : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Test suite for generating calls to UE measurements test case * ns3::LteUeMeasurementsPiecewiseTestCase3. @@ -415,7 +408,6 @@ class LteUeMeasurementsPiecewiseTestSuite3 : public TestSuite /** * \ingroup lte-test - * \ingroup tests * * \brief Testing UE measurements in LTE with simulation of 3 eNodeB and 1 UE in * piecewise configuration and 240 ms report interval. @@ -537,7 +529,6 @@ class LteUeMeasurementsPiecewiseTestCase3 : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Test suite for generating calls to UE measurements test case * ns3::LteUeMeasurementsHandoverTestCase. @@ -550,7 +541,6 @@ class LteUeMeasurementsHandoverTestSuite : public TestSuite /** * \ingroup lte-test - * \ingroup tests * * \brief Testing UE measurements in LTE with simulation of 2 eNodeB and 1 UE in * a handover configuration. diff --git a/src/lte/test/lte-test-ue-phy.h b/src/lte/test/lte-test-ue-phy.h index c276ae20b..d23e30aaa 100644 --- a/src/lte/test/lte-test-ue-phy.h +++ b/src/lte/test/lte-test-ue-phy.h @@ -28,7 +28,6 @@ namespace ns3 /** * \ingroup lte-test - * \ingroup tests * * \brief Defines a simplified LtePhy class that is used for testing purposes * of downlink and uplink SINR generation. Used in LteDownlinkDataSinrTestCase diff --git a/src/lte/test/lte-test-uplink-power-control.cc b/src/lte/test/lte-test-uplink-power-control.cc index 0661e9381..6b16d2092 100644 --- a/src/lte/test/lte-test-uplink-power-control.cc +++ b/src/lte/test/lte-test-uplink-power-control.cc @@ -68,6 +68,10 @@ LteUplinkPowerControlTestSuite::LteUplinkPowerControlTestSuite() TestCase::QUICK); } +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LteUplinkPowerControlTestSuite lteUplinkPowerControlTestSuite; /** diff --git a/src/lte/test/lte-test-uplink-power-control.h b/src/lte/test/lte-test-uplink-power-control.h index 36d4f0e9f..6beda5c67 100644 --- a/src/lte/test/lte-test-uplink-power-control.h +++ b/src/lte/test/lte-test-uplink-power-control.h @@ -38,7 +38,6 @@ class MobilityModel; /** * \ingroup lte-test - * \ingroup tests * * \brief Test 1.1 Uplink Power Control */ @@ -50,7 +49,6 @@ class LteUplinkPowerControlTestSuite : public TestSuite /** * \ingroup lte-test - * \ingroup tests * * \brief Lte Uplink Power Control Test Case */ @@ -138,7 +136,6 @@ class LteUplinkPowerControlTestCase : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief Lte Uplink Open Loop Power Control Test Case */ @@ -159,7 +156,6 @@ class LteUplinkOpenLoopPowerControlTestCase : public LteUplinkPowerControlTestCa /** * \ingroup lte-test - * \ingroup tests * * \brief Lte Uplink Closed Loop Power Control Absolute Mode Test Case */ @@ -180,7 +176,6 @@ class LteUplinkClosedLoopPowerControlAbsoluteModeTestCase : public LteUplinkPowe /** * \ingroup lte-test - * \ingroup tests * * \brief Lte Uplink Closed Loop Power Control Accumulated Mode Test Case */ diff --git a/src/lte/test/lte-test-uplink-sinr.cc b/src/lte/test/lte-test-uplink-sinr.cc index 314785c0b..469317f38 100644 --- a/src/lte/test/lte-test-uplink-sinr.cc +++ b/src/lte/test/lte-test-uplink-sinr.cc @@ -122,6 +122,10 @@ LteUplinkSinrTestSuite::LteUplinkSinrTestSuite() TestCase::QUICK); } +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LteUplinkSinrTestSuite lteUplinkSinrTestSuite; /** diff --git a/src/lte/test/lte-test-uplink-sinr.h b/src/lte/test/lte-test-uplink-sinr.h index a3786e82e..7daa2d5bc 100644 --- a/src/lte/test/lte-test-uplink-sinr.h +++ b/src/lte/test/lte-test-uplink-sinr.h @@ -29,7 +29,6 @@ using namespace ns3; /** * \ingroup lte-test - * \ingroup tests * * \brief Test 1.2 SINR calculation in uplink */ @@ -41,7 +40,6 @@ class LteUplinkSinrTestSuite : public TestSuite /** * \ingroup lte-test - * \ingroup tests * * \brief Test generation of SINR in the uplink. Test schedules the signal and the interference * signals and it evaluates if the obtained value for SINR corresponds to the theoretical value @@ -75,7 +73,6 @@ class LteUplinkDataSinrTestCase : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief In this test one signal will be of interest, i.e., the * SRS of the first signal will have the same CellId of the diff --git a/src/lte/test/test-asn1-encoding.cc b/src/lte/test/test-asn1-encoding.cc index f76e90333..b11f70733 100644 --- a/src/lte/test/test-asn1-encoding.cc +++ b/src/lte/test/test-asn1-encoding.cc @@ -36,7 +36,6 @@ NS_LOG_COMPONENT_DEFINE("Asn1EncodingTest"); /** * \ingroup lte-test - * \ingroup tests * * \brief Contains ASN encoding test utility functions. */ @@ -108,7 +107,6 @@ class TestUtils // --------------------------- CLASS RrcHeaderTestCase ----------------------------- /** * \ingroup lte-test - * \ingroup tests * * \brief This class provides common functions to be inherited * by the children TestCases @@ -326,7 +324,6 @@ RrcHeaderTestCase::AssertEqualRadioResourceConfigDedicated( /** * \ingroup lte-test - * \ingroup tests * * \brief Rrc Connection Request Test Case */ @@ -379,7 +376,6 @@ RrcConnectionRequestTestCase::DoRun() /** * \ingroup lte-test - * \ingroup tests * * \brief Rrc Connection Setup Test Case */ @@ -437,7 +433,6 @@ RrcConnectionSetupTestCase::DoRun() /** * \ingroup lte-test - * \ingroup tests * * \brief Rrc Connection Setup Complete Test Case */ @@ -491,7 +486,6 @@ RrcConnectionSetupCompleteTestCase::DoRun() /** * \ingroup lte-test - * \ingroup tests * * \brief Rrc Connection Reconfiguration Complete Test Case */ @@ -546,7 +540,6 @@ RrcConnectionReconfigurationCompleteTestCase::DoRun() /** * \ingroup lte-test - * \ingroup tests * * \brief Rrc Connection Reconfiguration Test Case */ @@ -785,7 +778,6 @@ RrcConnectionReconfigurationTestCase::DoRun() /** * \ingroup lte-test - * \ingroup tests * * \brief Handover Preparation Info Test Case */ @@ -895,7 +887,6 @@ HandoverPreparationInfoTestCase::DoRun() /** * \ingroup lte-test - * \ingroup tests * * \brief Rrc Connection Reestablishment Request Test Case */ @@ -955,7 +946,6 @@ RrcConnectionReestablishmentRequestTestCase::DoRun() /** * \ingroup lte-test - * \ingroup tests * * \brief Rrc Connection Reestablishment Test Case */ @@ -1012,7 +1002,6 @@ RrcConnectionReestablishmentTestCase::DoRun() /** * \ingroup lte-test - * \ingroup tests * * \brief Rrc Connection Reestablishment Complete Test Case */ @@ -1067,7 +1056,6 @@ RrcConnectionReestablishmentCompleteTestCase::DoRun() /** * \ingroup lte-test - * \ingroup tests * * \brief Rrc Connection Reject Test Case */ @@ -1121,7 +1109,6 @@ RrcConnectionRejectTestCase::DoRun() /** * \ingroup lte-test - * \ingroup tests * * \brief Measurement Report Test Case */ @@ -1259,7 +1246,6 @@ MeasurementReportTestCase::DoRun() /** * \ingroup lte-test - * \ingroup tests * * \brief Asn1Encoding Test Suite */ @@ -1286,4 +1272,8 @@ Asn1EncodingSuite::Asn1EncodingSuite() AddTestCase(new MeasurementReportTestCase(), TestCase::QUICK); } -Asn1EncodingSuite asn1EncodingSuite; +/** + * \ingroup lte-test + * Static variable for test initialization + */ +Asn1EncodingSuite g_asn1EncodingSuite; diff --git a/src/lte/test/test-epc-tft-classifier.cc b/src/lte/test/test-epc-tft-classifier.cc index 6beda0322..ec58896d5 100644 --- a/src/lte/test/test-epc-tft-classifier.cc +++ b/src/lte/test/test-epc-tft-classifier.cc @@ -39,7 +39,6 @@ NS_LOG_COMPONENT_DEFINE("TestEpcTftClassifier"); /** * \ingroup lte-test - * \ingroup tests * * \brief Test case to check the functionality of the Tft Classifier. Test * consist of defining different TFT configurations, i.e. direction, ports, @@ -206,7 +205,6 @@ EpcTftClassifierTestCase::DoRun() /** * \ingroup lte-test - * \ingroup tests * * \brief Epc Tft Classifier Test Suite */ @@ -216,6 +214,10 @@ class EpcTftClassifierTestSuite : public TestSuite EpcTftClassifierTestSuite(); }; +/** + * \ingroup lte-test + * Static variable for test initialization + */ static EpcTftClassifierTestSuite g_lteTftClassifierTestSuite; EpcTftClassifierTestSuite::EpcTftClassifierTestSuite() diff --git a/src/lte/test/test-lte-antenna.cc b/src/lte/test/test-lte-antenna.cc index 93418b4ad..9d5a8c7c8 100644 --- a/src/lte/test/test-lte-antenna.cc +++ b/src/lte/test/test-lte-antenna.cc @@ -41,7 +41,6 @@ NS_LOG_COMPONENT_DEFINE("LteAntennaTest"); /** * \ingroup lte-test - * \ingroup tests * * \brief Tests that the propagation model and the antenna parameters are * generate the correct values. Different test cases are created by specifying different @@ -264,7 +263,6 @@ LteEnbAntennaTestCase::DoRun() /** * \ingroup lte-test - * \ingroup tests * * \brief Lte Enb Antenna Test Suite */ @@ -310,4 +308,8 @@ LteAntennaTestSuite::LteAntennaTestSuite() AddTestCase(new LteEnbAntennaTestCase(-120.0, 120.0, 1, -0.1, -12.754), TestCase::QUICK); } -static LteAntennaTestSuite lteAntennaTestSuite; +/** + * \ingroup lte-test + * Static variable for test initialization + */ +static LteAntennaTestSuite g_lteAntennaTestSuite; diff --git a/src/lte/test/test-lte-epc-e2e-data.cc b/src/lte/test/test-lte-epc-e2e-data.cc index e3603e3ff..706c7b0d1 100644 --- a/src/lte/test/test-lte-epc-e2e-data.cc +++ b/src/lte/test/test-lte-epc-e2e-data.cc @@ -44,7 +44,6 @@ NS_LOG_COMPONENT_DEFINE("LteEpcE2eData"); /** * \ingroup lte-test - * \ingroup tests */ /// BearerTestData structure @@ -91,7 +90,6 @@ struct EnbTestData /** * \ingroup lte-test - * \ingroup tests * * \brief Test that e2e packet flow is correct. Compares the data send and the * data received. Test uses mostly the PDCP stats to check the performance. @@ -375,7 +373,7 @@ LteEpcE2eDataTestCase::DoRun() } /** - * \ingroup tests lte-test + * \ingroup lte-test * * \brief Test that the S1-U interface implementation works correctly */ diff --git a/src/lte/test/test-lte-handover-delay.cc b/src/lte/test/test-lte-handover-delay.cc index c860e2add..7cf84a4e0 100644 --- a/src/lte/test/test-lte-handover-delay.cc +++ b/src/lte/test/test-lte-handover-delay.cc @@ -44,7 +44,7 @@ using namespace ns3; NS_LOG_COMPONENT_DEFINE("LteHandoverDelayTest"); /** - * \ingroup tests lte-test + * \ingroup lte-test * * \brief Verifying that the time needed for handover is under a * specified threshold. @@ -286,7 +286,6 @@ LteHandoverDelayTestCase::EnbHandoverEndOkCallback(std::string context, /** * \ingroup lte-test - * \ingroup tests * * \brief Lte Handover Delay Test Suite */ diff --git a/src/lte/test/test-lte-handover-failure.cc b/src/lte/test/test-lte-handover-failure.cc index 2fc42374c..f53d8e306 100644 --- a/src/lte/test/test-lte-handover-failure.cc +++ b/src/lte/test/test-lte-handover-failure.cc @@ -46,7 +46,6 @@ NS_LOG_COMPONENT_DEFINE("LteHandoverFailureTest"); /** * \ingroup lte-test - * \ingroup tests * * \brief Verifying that a handover failure occurs due to various causes * @@ -364,7 +363,6 @@ LteHandoverFailureTestCase::DoTeardown() /** * \ingroup lte-test - * \ingroup tests * * The following log components can be used to debug this test's behavior: * LteHandoverFailureTest:LteEnbRrc:LteEnbMac:LteUeRrc:EpcX2 diff --git a/src/lte/test/test-lte-handover-target.cc b/src/lte/test/test-lte-handover-target.cc index 9238e22bf..45d851491 100644 --- a/src/lte/test/test-lte-handover-target.cc +++ b/src/lte/test/test-lte-handover-target.cc @@ -49,7 +49,6 @@ NS_LOG_COMPONENT_DEFINE("LteHandoverTargetTest"); /** * \ingroup lte-test - * \ingroup tests * * \brief Testing a handover algorithm, verifying that it selects the right * target cell when more than one options available. @@ -449,4 +448,8 @@ LteHandoverTargetTestSuite::LteHandoverTargetTestSuite() } // end of LteHandoverTargetTestSuite () +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LteHandoverTargetTestSuite g_lteHandoverTargetTestSuiteInstance; diff --git a/src/lte/test/test-lte-rlc-header.cc b/src/lte/test/test-lte-rlc-header.cc index 09b6c715c..f1aef251b 100644 --- a/src/lte/test/test-lte-rlc-header.cc +++ b/src/lte/test/test-lte-rlc-header.cc @@ -35,7 +35,6 @@ namespace ns3 /** * \ingroup lte-test - * \ingroup tests * * \brief Test Utils */ @@ -106,7 +105,6 @@ class TestUtils /** * \ingroup lte-test - * \ingroup tests * * \brief Rlc Am Status Pdu Test Case */ @@ -187,7 +185,6 @@ RlcAmStatusPduTestCase::DoRun() /** * \ingroup lte-test - * \ingroup tests * * \brief Lte Rlc Header Test Suite */ diff --git a/src/lte/test/test-lte-rrc.cc b/src/lte/test/test-lte-rrc.cc index d87095664..c7a1865ce 100644 --- a/src/lte/test/test-lte-rrc.cc +++ b/src/lte/test/test-lte-rrc.cc @@ -31,7 +31,6 @@ NS_LOG_COMPONENT_DEFINE("LteRrcTest"); /** * \ingroup lte-test - * \ingroup tests * * \brief Test rrc connection establishment. */ @@ -584,7 +583,6 @@ LteRrcConnectionEstablishmentTestCase::ConnectionTimeoutCallback(std::string con /** * \ingroup lte-test - * \ingroup tests * * \brief Lte Rrc Connection Establishment Error Test Case */ @@ -765,7 +763,6 @@ LteRrcConnectionEstablishmentErrorTestCase::JumpBack() /** * \ingroup lte-test - * \ingroup tests * * \brief Lte Rrc Test Suite */ @@ -895,4 +892,8 @@ LteRrcTestSuite::LteRrcTestSuite() TestCase::QUICK); } +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LteRrcTestSuite g_lteRrcTestSuiteInstance; diff --git a/src/lte/test/test-lte-x2-handover-measures.cc b/src/lte/test/test-lte-x2-handover-measures.cc index d95c4d920..156bec805 100644 --- a/src/lte/test/test-lte-x2-handover-measures.cc +++ b/src/lte/test/test-lte-x2-handover-measures.cc @@ -32,7 +32,6 @@ NS_LOG_COMPONENT_DEFINE("LteX2HandoverMeasuresTest"); /** * \ingroup lte-test - * \ingroup tests * * \brief CheckPointEvent structure */ @@ -65,7 +64,6 @@ struct CheckPointEvent /** * \ingroup lte-test - * \ingroup tests * * \brief Test different X2 handover measures and algorithms, e.g. A2A4RsrqHandoverAlgorithm and * A3RsrpHandoverAlgorithm. Test defines different handover parameters and scenario configurations. @@ -147,7 +145,6 @@ class LteX2HandoverMeasuresTestCase : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief BearerData structure */ @@ -162,7 +159,6 @@ class LteX2HandoverMeasuresTestCase : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief UeData structure */ @@ -740,7 +736,6 @@ LteX2HandoverMeasuresTestCase::CheckStats(uint32_t ueIndex) /** * \ingroup lte-test - * \ingroup tests * * \brief Lte X2 Handover Measures Test Suite */ @@ -1007,4 +1002,8 @@ LteX2HandoverMeasuresTestSuite::LteX2HandoverMeasuresTestSuite() } // end of LteX2HandoverMeasuresTestSuite () +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LteX2HandoverMeasuresTestSuite g_lteX2HandoverMeasuresTestSuiteInstance; diff --git a/src/lte/test/test-lte-x2-handover.cc b/src/lte/test/test-lte-x2-handover.cc index 70b869114..5c08275f6 100644 --- a/src/lte/test/test-lte-x2-handover.cc +++ b/src/lte/test/test-lte-x2-handover.cc @@ -31,7 +31,6 @@ NS_LOG_COMPONENT_DEFINE("LteX2HandoverTest"); /** * \ingroup lte-test - * \ingroup tests * * \brief HandoverEvent structure */ @@ -45,7 +44,6 @@ struct HandoverEvent /** * \ingroup lte-test - * \ingroup tests * * \brief Test X2 Handover. In this test is used NoOpHandoverAlgorithm and * the request for handover is generated manually, and it is not based on measurements. @@ -123,7 +121,6 @@ class LteX2HandoverTestCase : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief BearerData structure */ @@ -138,7 +135,6 @@ class LteX2HandoverTestCase : public TestCase /** * \ingroup lte-test - * \ingroup tests * * \brief UeData structure */ @@ -657,7 +653,6 @@ LteX2HandoverTestCase::CheckStatsAWhileAfterHandover(uint32_t ueIndex) /** * \ingroup lte-test - * \ingroup tests * * \brief LTE X2 Handover Test Suite. * @@ -896,4 +891,8 @@ LteX2HandoverTestSuite::LteX2HandoverTestSuite() } } +/** + * \ingroup lte-test + * Static variable for test initialization + */ static LteX2HandoverTestSuite g_lteX2HandoverTestSuiteInstance; diff --git a/src/mesh/test/dot11s/dot11s-test-suite.cc b/src/mesh/test/dot11s/dot11s-test-suite.cc index 716f32e67..99b0744ec 100644 --- a/src/mesh/test/dot11s/dot11s-test-suite.cc +++ b/src/mesh/test/dot11s/dot11s-test-suite.cc @@ -35,7 +35,6 @@ using namespace dot11s; /** * \ingroup dot11s-test - * \ingroup tests * * \brief Built-in self test for MeshHeader */ @@ -95,7 +94,6 @@ MeshHeaderTest::DoRun() /** * \ingroup mesh-test - * \ingroup tests * * \brief Unit test for HwmpRtable */ @@ -278,7 +276,6 @@ PeerLinkFrameStartTest::DoRun() /** * \ingroup mesh-test - * \ingroup tests * * \brief Dot11s Test Suite */ diff --git a/src/mesh/test/dot11s/hwmp-proactive-regression.h b/src/mesh/test/dot11s/hwmp-proactive-regression.h index c3ef3a67c..f7869e91e 100644 --- a/src/mesh/test/dot11s/hwmp-proactive-regression.h +++ b/src/mesh/test/dot11s/hwmp-proactive-regression.h @@ -27,7 +27,6 @@ using namespace ns3; /** * \ingroup dot11s-test - * \ingroup tests * * \brief There are 5 stations set into a row, the center station is root. * Regression test indicates that traffic goes from the first to the diff --git a/src/mesh/test/dot11s/hwmp-reactive-regression.h b/src/mesh/test/dot11s/hwmp-reactive-regression.h index 0a8cc48a6..c3bef8cd3 100644 --- a/src/mesh/test/dot11s/hwmp-reactive-regression.h +++ b/src/mesh/test/dot11s/hwmp-reactive-regression.h @@ -26,7 +26,6 @@ using namespace ns3; /** * \ingroup dot11s-test - * \ingroup tests * * \brief test for multihop path establishing and path error * procedures diff --git a/src/mesh/test/dot11s/hwmp-simplest-regression.h b/src/mesh/test/dot11s/hwmp-simplest-regression.h index 47c6ca8f8..9440a636c 100644 --- a/src/mesh/test/dot11s/hwmp-simplest-regression.h +++ b/src/mesh/test/dot11s/hwmp-simplest-regression.h @@ -27,7 +27,6 @@ using namespace ns3; /** * \ingroup dot11s-test - * \ingroup tests * * \brief Peering Management & HWM Protocol regression test * Initiate scenario with 2 stations. Procedure of opening peer link diff --git a/src/mesh/test/dot11s/hwmp-target-flags-regression.h b/src/mesh/test/dot11s/hwmp-target-flags-regression.h index 578ffc305..bc21345ae 100644 --- a/src/mesh/test/dot11s/hwmp-target-flags-regression.h +++ b/src/mesh/test/dot11s/hwmp-target-flags-regression.h @@ -27,7 +27,6 @@ using namespace ns3; /** * \ingroup dot11s-test - * \ingroup tests * * \brief This is a test for intermediate reply and saving routing * information about neighbour. 4 stations and 3 UDP ping streams are initiated. diff --git a/src/mesh/test/dot11s/pmp-regression.h b/src/mesh/test/dot11s/pmp-regression.h index a641e927f..b428c2d5f 100644 --- a/src/mesh/test/dot11s/pmp-regression.h +++ b/src/mesh/test/dot11s/pmp-regression.h @@ -27,7 +27,6 @@ using namespace ns3; /** * \ingroup dot11s-test - * \ingroup tests * * \brief Peering Management Protocol regression test * diff --git a/src/mesh/test/dot11s/regression.cc b/src/mesh/test/dot11s/regression.cc index f28d95b6d..6d924c611 100644 --- a/src/mesh/test/dot11s/regression.cc +++ b/src/mesh/test/dot11s/regression.cc @@ -29,7 +29,6 @@ using namespace ns3; /** * \ingroup dot11s-test - * \ingroup tests * * \brief Dot11s Regression Suite */ diff --git a/src/mesh/test/flame/flame-regression.h b/src/mesh/test/flame/flame-regression.h index a5fce5ad4..b79540877 100644 --- a/src/mesh/test/flame/flame-regression.h +++ b/src/mesh/test/flame/flame-regression.h @@ -32,7 +32,6 @@ using namespace ns3; /** * \ingroup flame-test - * \ingroup tests * * \brief FLAME protocol regression test of three stations: * \verbatim diff --git a/src/mesh/test/flame/flame-test-suite.cc b/src/mesh/test/flame/flame-test-suite.cc index c8ae46179..be4c1ee93 100644 --- a/src/mesh/test/flame/flame-test-suite.cc +++ b/src/mesh/test/flame/flame-test-suite.cc @@ -28,7 +28,6 @@ using namespace flame; /** * \ingroup flame-test - * \ingroup tests * * \brief Built-in self test for FlameHeader */ @@ -62,7 +61,6 @@ FlameHeaderTest::DoRun() /** * \ingroup flame-test - * \ingroup tests * * \brief Unit test for FlameRtable */ @@ -143,7 +141,6 @@ FlameRtableTest::DoRun() /** * \ingroup flame-test - * \ingroup tests * * \brief Flame Test Suite */ diff --git a/src/mesh/test/flame/regression.cc b/src/mesh/test/flame/regression.cc index 7d8017ded..5db06b345 100644 --- a/src/mesh/test/flame/regression.cc +++ b/src/mesh/test/flame/regression.cc @@ -25,7 +25,6 @@ using namespace ns3; /** * \ingroup flame-test - * \ingroup tests * * \brief Flame Regression Suite */ diff --git a/src/mesh/test/mesh-information-element-vector-test-suite.cc b/src/mesh/test/mesh-information-element-vector-test-suite.cc index 64916f84d..cee386eb8 100644 --- a/src/mesh/test/mesh-information-element-vector-test-suite.cc +++ b/src/mesh/test/mesh-information-element-vector-test-suite.cc @@ -35,12 +35,12 @@ using namespace ns3; /** * \ingroup mesh + * \ingroup tests * \defgroup mesh-test mesh module tests */ /** * \ingroup mesh-test - * \ingroup tests * * \brief Built-in self test for MeshInformationElementVector and all IE */ @@ -152,7 +152,6 @@ MeshInformationElementVectorBist::DoRun() /** * \ingroup mesh-test - * \ingroup tests * * \brief Mesh Test Suite */ diff --git a/src/mobility/test/geo-to-cartesian-test.cc b/src/mobility/test/geo-to-cartesian-test.cc index 99e80ba4b..e903df793 100644 --- a/src/mobility/test/geo-to-cartesian-test.cc +++ b/src/mobility/test/geo-to-cartesian-test.cc @@ -1486,12 +1486,12 @@ const double ZWGS84_MATLAB[216] = { /** * \ingroup mobility + * \ingroup tests * \defgroup mobility-test mobility module tests */ /** * \ingroup mobility-test - * \ingroup tests * * \brief Geo To Cartesian Test Case * @@ -1674,7 +1674,6 @@ GeoToCartesianTestCase::DoRun() /** * \ingroup mobility-test - * \ingroup tests * * \brief Cartesian to Geo Test Case * @@ -1791,7 +1790,6 @@ CartesianToGeoTestCase::DoRun() /** * \ingroup mobility-test - * \ingroup tests * * \brief Geo To Cartesian Test Suite */ @@ -1876,4 +1874,8 @@ GeoToCartesianTestSuite::GeoToCartesianTestSuite() } } +/** + * \ingroup mobility-test + * Static variable for test initialization + */ static GeoToCartesianTestSuite g_GeoToCartesianTestSuite; diff --git a/src/mobility/test/mobility-test-suite.cc b/src/mobility/test/mobility-test-suite.cc index 8363975f2..5e78dd5e5 100644 --- a/src/mobility/test/mobility-test-suite.cc +++ b/src/mobility/test/mobility-test-suite.cc @@ -35,7 +35,6 @@ using namespace ns3; /** * \ingroup mobility-test - * \ingroup tests * * \brief Test whether course change notifications occur regardless of calls * to Update() position (which are triggered by calls to GetPosition()) @@ -113,7 +112,6 @@ WaypointLazyNotifyFalse::DoRun() /** * \ingroup mobility-test - * \ingroup tests * * \brief Waypoint Lazy Notify True */ @@ -188,7 +186,6 @@ WaypointLazyNotifyTrue::DoRun() /** * \ingroup mobility-test - * \ingroup tests * * \brief Waypoint Initial Position Is Waypoint Test */ @@ -382,7 +379,6 @@ WaypointInitialPositionIsWaypoint::DoRun() /** * \ingroup mobility-test - * \ingroup tests * * \brief Waypoint Mobility Model Via Helper Test */ @@ -478,7 +474,6 @@ WaypointMobilityModelViaHelper::DoRun() /** * \ingroup mobility-test - * \ingroup tests * * \brief Mobility Test Suite */ @@ -497,4 +492,8 @@ MobilityTestSuite::MobilityTestSuite() AddTestCase(new WaypointMobilityModelViaHelper, TestCase::QUICK); } -static MobilityTestSuite mobilityTestSuite; ///< the test suite +/** + * \ingroup mobility-test + * Static variable for test initialization + */ +static MobilityTestSuite mobilityTestSuite; diff --git a/src/mobility/test/mobility-trace-test-suite.cc b/src/mobility/test/mobility-trace-test-suite.cc index 9f445c33a..589aad3a8 100644 --- a/src/mobility/test/mobility-trace-test-suite.cc +++ b/src/mobility/test/mobility-trace-test-suite.cc @@ -35,7 +35,6 @@ using namespace ns3; /** * \ingroup mobility-test - * \ingroup tests * * \brief Mobility Trace Test Case */ @@ -114,7 +113,6 @@ MobilityTraceTestCase::DoRun() /** * \ingroup mobility-test - * \ingroup tests * * \brief Mobility Trace Test Suite */ @@ -131,4 +129,8 @@ MobilityTraceTestSuite::MobilityTraceTestSuite() AddTestCase(new MobilityTraceTestCase, TestCase::QUICK); } -static MobilityTraceTestSuite mobilityTraceTestSuite; ///< the test suite +/** + * \ingroup mobility-test + * Static variable for test initialization + */ +static MobilityTraceTestSuite mobilityTraceTestSuite; diff --git a/src/mobility/test/ns2-mobility-helper-test-suite.cc b/src/mobility/test/ns2-mobility-helper-test-suite.cc index b037e59d5..c7a207e7c 100644 --- a/src/mobility/test/ns2-mobility-helper-test-suite.cc +++ b/src/mobility/test/ns2-mobility-helper-test-suite.cc @@ -76,7 +76,6 @@ AreVectorsEqual(const Vector& actual, const Vector& limit, double tol) /** * \ingroup mobility-test - * \ingroup tests * * \brief Every test case is supposed to: * 1. Generate short mobility trace file @@ -322,7 +321,6 @@ class Ns2MobilityHelperTest : public TestCase /** * \ingroup mobility-test - * \ingroup tests * * \brief The test suite */ diff --git a/src/mobility/test/rand-cart-around-geo-test.cc b/src/mobility/test/rand-cart-around-geo-test.cc index 5fe90a172..f1e4f0d48 100644 --- a/src/mobility/test/rand-cart-around-geo-test.cc +++ b/src/mobility/test/rand-cart-around-geo-test.cc @@ -57,7 +57,6 @@ static const double EARTH_RADIUS = 6371e3; /** * \ingroup mobility-test - * \ingroup tests * * \brief Rand Cart Around Geo Test Case */ @@ -174,7 +173,6 @@ RandCartAroundGeoTestCase::DoRun() /** * \ingroup mobility-test - * \ingroup tests * * \brief Rand Cart Around Geo Test Suite */ @@ -209,4 +207,8 @@ RandCartAroundGeoTestSuite::RandCartAroundGeoTestSuite() } } -static RandCartAroundGeoTestSuite g_RandCartAroundGeoTestSuite; ///< the test suite +/** + * \ingroup mobility-test + * Static variable for test initialization + */ +static RandCartAroundGeoTestSuite g_RandCartAroundGeoTestSuite; diff --git a/src/mobility/test/steady-state-random-waypoint-mobility-model-test.cc b/src/mobility/test/steady-state-random-waypoint-mobility-model-test.cc index f39c7cb3b..19a9200b4 100644 --- a/src/mobility/test/steady-state-random-waypoint-mobility-model-test.cc +++ b/src/mobility/test/steady-state-random-waypoint-mobility-model-test.cc @@ -30,7 +30,6 @@ using namespace ns3; /** * \ingroup mobility-test - * \ingroup tests * * \brief Steady State Random Waypoint Test */ @@ -153,7 +152,6 @@ SteadyStateRandomWaypointTest::DistribCompare() /** * \ingroup mobility-test - * \ingroup tests * * \brief Steady State Random Waypoint Test Suite */ diff --git a/src/mobility/test/waypoint-mobility-model-test.cc b/src/mobility/test/waypoint-mobility-model-test.cc index 318dd3a9a..2aeeac8e4 100644 --- a/src/mobility/test/waypoint-mobility-model-test.cc +++ b/src/mobility/test/waypoint-mobility-model-test.cc @@ -27,7 +27,6 @@ using namespace ns3; /** * \ingroup mobility-test - * \ingroup tests * * \brief Waypoint Mobility Model Notify Test */ @@ -172,7 +171,6 @@ WaypointMobilityModelNotifyTest::CourseChangeCallback(Ptr m /** * \ingroup mobility-test - * \ingroup tests * * \brief Waypoint Mobility Model Add Waypoint Test */ @@ -257,7 +255,6 @@ WaypointMobilityModelAddWaypointTest::CourseChangeCallback(Ptr /** - * \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 + * Example of TopologyReader: read in a topology in a specificed format. + * + * This example can be used with the following parameters: + * - --format=Inet --input=src/topology-read/examples/Inet_small_toposample.txt + * - --format=Inet --input=src/topology-read/examples/Inet_toposample.txt + * - --format=Orbis --input=src/topology-read/examples/Orbis_toposample.txt + * - --format=Rocket + * --input=src/topology-read/examples/RocketFuel_sample_4755.r0.cch_maps.txt + * - --format=Rocket + * --input=src/topology-read/examples/RocketFuel_toposample_1239_weights.txt */ using namespace ns3; @@ -87,6 +73,8 @@ main(int argc, char* argv[]) std::string format("Inet"); std::string input("src/topology-read/examples/Inet_small_toposample.txt"); + LogComponentEnable("TopologyCreationExperiment", LOG_LEVEL_INFO); + // Set up command line parameters used to control the experiment. CommandLine cmd(__FILE__); cmd.AddValue("format", "Format to use for data input [Orbis|Inet|Rocketfuel].", format); 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 fe9bbcbfb..bef919e80 100644 --- a/src/topology-read/test/rocketfuel-topology-reader-test-suite.cc +++ b/src/topology-read/test/rocketfuel-topology-reader-test-suite.cc @@ -33,8 +33,9 @@ using namespace ns3; /** - * \ingroup topology * \defgroup topology-test Topology module tests + * \ingroup topology + * \ingroup tests */ /** @@ -45,7 +46,6 @@ using namespace ns3; /** * \ingroup topology-test - * \ingroup tests * \brief Rocketfuel Topology Reader Weights Test */ @@ -90,8 +90,6 @@ RocketfuelTopologyReaderWeightsTest::DoRun() /** * \ingroup topology-test - * \ingroup tests - * \brief Rocketfuel Topology Reader Maps Test */ class RocketfuelTopologyReaderMapsTest : public TestCase @@ -135,7 +133,6 @@ RocketfuelTopologyReaderMapsTest::DoRun() /** * \ingroup topology-test - * \ingroup tests * * \brief Rocketfuel Topology Reader TestSuite */ @@ -154,5 +151,8 @@ RocketfuelTopologyReaderTestSuite::RocketfuelTopologyReaderTestSuite() AddTestCase(new RocketfuelTopologyReaderMapsTest(), TestCase::QUICK); } -static RocketfuelTopologyReaderTestSuite - g_rocketfuelTopologyReaderTestSuite; //!< Static variable for test initialization +/** + * \ingroup topology-test + * Static variable for test initialization + */ +static RocketfuelTopologyReaderTestSuite g_rocketfuelTopologyReaderTestSuite; diff --git a/src/traffic-control/model/traffic-control-layer.h b/src/traffic-control/model/traffic-control-layer.h index 6cc7dfff3..ee7f833cc 100644 --- a/src/traffic-control/model/traffic-control-layer.h +++ b/src/traffic-control/model/traffic-control-layer.h @@ -36,8 +36,10 @@ class QueueDisc; class NetDeviceQueueInterface; /** - * \defgroup traffic-control - * + * \defgroup traffic-control Traffic Control model + */ + +/** * The Traffic Control layer aims at introducing an equivalent of the Linux Traffic * Control infrastructure into ns-3. The Traffic Control layer sits in between * the NetDevices (L2) and any network protocol (e.g., IP). It is in charge of diff --git a/src/traffic-control/test/adaptive-red-queue-disc-test-suite.cc b/src/traffic-control/test/adaptive-red-queue-disc-test-suite.cc index 78269825f..4a35c0367 100644 --- a/src/traffic-control/test/adaptive-red-queue-disc-test-suite.cc +++ b/src/traffic-control/test/adaptive-red-queue-disc-test-suite.cc @@ -31,12 +31,12 @@ using namespace ns3; /** * \ingroup traffic-control + * \ingroup tests * \defgroup traffic-control-test traffic-control module tests */ /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Ared Queue Disc Test Item */ @@ -83,7 +83,6 @@ AredQueueDiscTestItem::Mark() /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Ared Queue Disc Test Case */ @@ -413,7 +412,6 @@ AredQueueDiscTestCase::DoRun() /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Ared Queue Disc Test Suite */ diff --git a/src/traffic-control/test/cobalt-queue-disc-test-suite.cc b/src/traffic-control/test/cobalt-queue-disc-test-suite.cc index 58693077d..197a293e3 100644 --- a/src/traffic-control/test/cobalt-queue-disc-test-suite.cc +++ b/src/traffic-control/test/cobalt-queue-disc-test-suite.cc @@ -34,7 +34,6 @@ using namespace ns3; /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Cobalt Queue Disc Test Item */ @@ -92,7 +91,6 @@ CobaltQueueDiscTestItem::Mark() /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Test 1: simple enqueue/dequeue with no drops */ @@ -263,7 +261,6 @@ CobaltQueueDiscBasicEnqueueDequeue::DoRun() /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Test 2: Cobalt Queue Disc Drop Test Item */ @@ -384,7 +381,6 @@ CobaltQueueDiscDropTest::DoRun() /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Test 3: Cobalt Queue Disc ECN marking Test Item */ @@ -838,7 +834,6 @@ CobaltQueueDiscMarkTest::Dequeue(Ptr queue, uint32_t modeSize, /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Test 4: Cobalt Queue Disc CE Threshold marking Test Item */ @@ -1050,7 +1045,6 @@ CobaltQueueDiscCeThresholdTest::DoRun() /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Test 5: Cobalt Queue Disc Enhanced Blue Test Item * This test checks that the Blue Enhancement is working correctly. This test checks that Pdrop @@ -1199,6 +1193,7 @@ CobaltQueueDiscEnhancedBlueTest::DequeueWithDelay(Ptr queue, } /** + * \ingroup traffic-control-test * The COBALT queue disc test suite. */ static class CobaltQueueDiscTestSuite : public TestSuite diff --git a/src/traffic-control/test/codel-queue-disc-test-suite.cc b/src/traffic-control/test/codel-queue-disc-test-suite.cc index 0a51fb5ed..1ab9e08fb 100644 --- a/src/traffic-control/test/codel-queue-disc-test-suite.cc +++ b/src/traffic-control/test/codel-queue-disc-test-suite.cc @@ -58,7 +58,6 @@ _reciprocal_scale(uint32_t val, uint32_t ep_ro) /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Codel Queue Disc Test Item */ @@ -114,7 +113,6 @@ CodelQueueDiscTestItem::Mark() /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Test 1: simple enqueue/dequeue with no drops */ @@ -277,7 +275,6 @@ CoDelQueueDiscBasicEnqueueDequeue::DoRun() /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Test 2: enqueue with drops due to queue overflow */ @@ -369,7 +366,6 @@ CoDelQueueDiscBasicOverflow::Enqueue(Ptr queue, uint32_t size, u /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Test 3: NewtonStep unit test - test against explicit port of Linux implementation */ @@ -408,7 +404,6 @@ CoDelQueueDiscNewtonStepTest::DoRun() /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Test 4: ControlLaw unit test - test against explicit port of Linux implementation */ @@ -467,7 +462,6 @@ CoDelQueueDiscControlLawTest::DoRun() /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Test 5: enqueue/dequeue with drops according to CoDel algorithm */ @@ -680,7 +674,6 @@ CoDelQueueDiscBasicDrop::Dequeue(Ptr queue, uint32_t modeSize) /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Test 6: enqueue/dequeue with marks according to CoDel algorithm */ @@ -1333,7 +1326,6 @@ CoDelQueueDiscBasicMark::Dequeue(Ptr queue, uint32_t modeSize, u /** * \ingroup traffic-control-test - * \ingroup tests * * \brief CoDel Queue Disc Test Suite */ diff --git a/src/traffic-control/test/fifo-queue-disc-test-suite.cc b/src/traffic-control/test/fifo-queue-disc-test-suite.cc index f5f4547e5..9e3fe3aa3 100644 --- a/src/traffic-control/test/fifo-queue-disc-test-suite.cc +++ b/src/traffic-control/test/fifo-queue-disc-test-suite.cc @@ -35,7 +35,6 @@ using namespace ns3; /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Fifo Queue Disc Test Item */ @@ -82,7 +81,6 @@ FifoQueueDiscTestItem::Mark() /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Fifo Queue Disc Test Case */ @@ -269,7 +267,6 @@ FifoQueueDiscTestCase::DoRun() /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Fifo Queue Disc Test Suite */ diff --git a/src/traffic-control/test/pie-queue-disc-test-suite.cc b/src/traffic-control/test/pie-queue-disc-test-suite.cc index c1380fb76..1484f9ca4 100644 --- a/src/traffic-control/test/pie-queue-disc-test-suite.cc +++ b/src/traffic-control/test/pie-queue-disc-test-suite.cc @@ -33,7 +33,6 @@ using namespace ns3; /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Pie Queue Disc Test Item */ @@ -103,7 +102,6 @@ PieQueueDiscTestItem::Mark() /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Pie Queue Disc Test Case */ @@ -849,7 +847,6 @@ PieQueueDiscTestCase::DoRun() /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Pie Queue Disc Test Suite */ diff --git a/src/traffic-control/test/prio-queue-disc-test-suite.cc b/src/traffic-control/test/prio-queue-disc-test-suite.cc index 792cefb3f..7d87f6681 100644 --- a/src/traffic-control/test/prio-queue-disc-test-suite.cc +++ b/src/traffic-control/test/prio-queue-disc-test-suite.cc @@ -35,7 +35,6 @@ using namespace ns3; /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Prio Queue Disc Test Item */ @@ -75,7 +74,6 @@ PrioQueueDiscTestItem::Mark() /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Prio Queue Disc Test Packet Filter */ @@ -134,7 +132,6 @@ PrioQueueDiscTestFilter::DoClassify(Ptr item) const /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Prio Queue Disc Test Case */ @@ -318,7 +315,6 @@ PrioQueueDiscTestCase::DoRun() /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Prio Queue Disc Test Suite */ diff --git a/src/traffic-control/test/queue-disc-traces-test-suite.cc b/src/traffic-control/test/queue-disc-traces-test-suite.cc index b1018e8cb..02ba2703f 100644 --- a/src/traffic-control/test/queue-disc-traces-test-suite.cc +++ b/src/traffic-control/test/queue-disc-traces-test-suite.cc @@ -30,7 +30,6 @@ using namespace ns3; /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Queue Disc Test Item */ @@ -71,7 +70,6 @@ QdTestItem::Mark() /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Test Child Queue Disc that may drop packets before enqueue or after dequeue */ @@ -142,7 +140,6 @@ TestChildQueueDisc::InitializeParams() /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Test Parent Queue Disc having a child of type TestChildQueueDisc */ @@ -197,7 +194,6 @@ TestParentQueueDisc::InitializeParams() /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Keep statistics based on traces */ @@ -304,7 +300,6 @@ TestCounter::ConnectTraces(Ptr qd) /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Queue Disc Traces Test Case * @@ -590,7 +585,6 @@ QueueDiscTracesTestCase::DoRun() /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Queue Disc Traces Test Suite */ diff --git a/src/traffic-control/test/red-queue-disc-test-suite.cc b/src/traffic-control/test/red-queue-disc-test-suite.cc index bcf4c8c85..2e85ef10c 100644 --- a/src/traffic-control/test/red-queue-disc-test-suite.cc +++ b/src/traffic-control/test/red-queue-disc-test-suite.cc @@ -32,7 +32,6 @@ using namespace ns3; /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Red Queue Disc Test Item */ @@ -83,7 +82,6 @@ RedQueueDiscTestItem::Mark() /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Red Queue Disc Test Case */ @@ -621,7 +619,6 @@ RedQueueDiscTestCase::DoRun() /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Red Queue Disc Test Suite */ diff --git a/src/traffic-control/test/tbf-queue-disc-test-suite.cc b/src/traffic-control/test/tbf-queue-disc-test-suite.cc index 7817ff3df..e2d2b5fc2 100644 --- a/src/traffic-control/test/tbf-queue-disc-test-suite.cc +++ b/src/traffic-control/test/tbf-queue-disc-test-suite.cc @@ -37,7 +37,6 @@ using namespace ns3; /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Tbf Queue Disc Test Item */ @@ -84,7 +83,6 @@ TbfQueueDiscTestItem::Mark() /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Tbf Queue Disc Test Case */ @@ -541,7 +539,6 @@ TbfQueueDiscTestCase::DoRun() /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Tbf Queue Disc Test Suite */ diff --git a/src/traffic-control/test/tc-flow-control-test-suite.cc b/src/traffic-control/test/tc-flow-control-test-suite.cc index f9e19add7..f9f9923a0 100644 --- a/src/traffic-control/test/tc-flow-control-test-suite.cc +++ b/src/traffic-control/test/tc-flow-control-test-suite.cc @@ -41,7 +41,6 @@ using namespace ns3; /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Queue Disc Test Item */ @@ -87,7 +86,6 @@ QueueDiscTestItem::Mark() /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Traffic Control Flow Control Test Case */ @@ -496,7 +494,6 @@ TcFlowControlTestCase::DoRun() /** * \ingroup traffic-control-test - * \ingroup tests * * \brief Traffic Control Flow Control Test Suite */ diff --git a/src/virtual-net-device/examples/CMakeLists.txt b/src/virtual-net-device/examples/CMakeLists.txt index 7fdcfd21b..9f49b3e43 100644 --- a/src/virtual-net-device/examples/CMakeLists.txt +++ b/src/virtual-net-device/examples/CMakeLists.txt @@ -1,6 +1,6 @@ build_lib_example( - NAME virtual-net-device - SOURCE_FILES virtual-net-device.cc + NAME virtual-net-device-example + SOURCE_FILES virtual-net-device-example.cc LIBRARIES_TO_LINK ${libvirtual-net-device} ${libpoint-to-point} diff --git a/src/virtual-net-device/examples/virtual-net-device.cc b/src/virtual-net-device/examples/virtual-net-device-example.cc similarity index 99% rename from src/virtual-net-device/examples/virtual-net-device.cc rename to src/virtual-net-device/examples/virtual-net-device-example.cc index f3af6274f..333a1a99e 100644 --- a/src/virtual-net-device/examples/virtual-net-device.cc +++ b/src/virtual-net-device/examples/virtual-net-device-example.cc @@ -41,13 +41,12 @@ // UDP/IP, but tunneling directly IP-over-IP would also be possible; // see src/node/ipv4-raw-socket-factory.h. -#include "ns3/virtual-net-device.h" - #include "ns3/applications-module.h" #include "ns3/core-module.h" #include "ns3/internet-module.h" #include "ns3/network-module.h" #include "ns3/point-to-point-module.h" +#include "ns3/virtual-net-device.h" #include #include diff --git a/src/visualizer/visualizer/core.py b/src/visualizer/visualizer/core.py index 5e76e24d2..34185b787 100644 --- a/src/visualizer/visualizer/core.py +++ b/src/visualizer/visualizer/core.py @@ -113,10 +113,10 @@ class Node(PyVizObject): # label ## @var _label_canvas_item # label canvas - ## @var selected - # selected property ## @var highlighted # highlighted property + ## @var selected + # selected property ## signal emitted whenever a tooltip is about to be shown for the node ## the first signal parameter is a python list of strings, to which @@ -301,7 +301,10 @@ class Node(PyVizObject): @param event: event @return none """ + + ## highlighted property self.highlighted = True + def on_leave_notify_event(self, view, target, event): """! On Leave event handle. diff --git a/src/visualizer/visualizer/ipython_view.py b/src/visualizer/visualizer/ipython_view.py index 40604273c..49a993350 100644 --- a/src/visualizer/visualizer/ipython_view.py +++ b/src/visualizer/visualizer/ipython_view.py @@ -23,6 +23,7 @@ import IPython from pkg_resources import parse_version +## Try to import IPython try: import IPython except ImportError: @@ -46,30 +47,10 @@ class IterableIPShell: # header ## @var config # config - ## @var user_ns - # user_ns - ## @var old_stdout - # saved stdout - ## @var old_stderr - # saved stderr - ## @var system - # system - ## @var cfg - # configuration ## @var colors # colors - ## @var raw_input_original - # original raw input - ## @var stdin - # cin - ## @var stdout - # cout - ## @var stderr - # cerr ## @var raw_input # raw input - ## @var excepthook - # exception hook ## Constructor def __init__(self,argv=None,user_ns=None,user_global_ns=None, cin=None, cout=None,cerr=None, input_func=None): diff --git a/utils/print-introspected-doxygen.cc b/utils/print-introspected-doxygen.cc index 5ef5f0d41..ee6171eae 100644 --- a/utils/print-introspected-doxygen.cc +++ b/utils/print-introspected-doxygen.cc @@ -139,8 +139,6 @@ SortedTraceSourceInfo(const TypeId tid) /** * Initialize the markup strings, for either doxygen or text. - * - * \param [in] outputText true for text output, false for doxygen output. */ void SetMarkup()