From 8cfc0f1b4012b21ccb91f24b35dc673ea30b12e8 Mon Sep 17 00:00:00 2001 From: Tommaso Pecorella Date: Fri, 28 Apr 2017 02:29:26 +0200 Subject: [PATCH] documentation: various test grouping fixes --- src/mesh/model/flame/flame-protocol.h | 2 +- src/mesh/test/dot11s/dot11s-test-suite.cc | 6 ++--- src/mesh/test/flame/flame-regression.h | 6 +++++ ...h-information-element-vector-test-suite.cc | 5 ++++ src/mobility/test/geo-to-cartesian-test.cc | 25 +++++++++---------- src/netanim/test/netanim-test.cc | 2 +- .../adaptive-red-queue-disc-test-suite.cc | 2 +- src/uan/test/uan-energy-model-test.cc | 2 +- src/wifi/test/80211b.c | 2 +- src/wimax/test/mac-messages-test.cc | 2 +- 10 files changed, 32 insertions(+), 22 deletions(-) diff --git a/src/mesh/model/flame/flame-protocol.h b/src/mesh/model/flame/flame-protocol.h index dc7e42f2c..ef151b65c 100644 --- a/src/mesh/model/flame/flame-protocol.h +++ b/src/mesh/model/flame/flame-protocol.h @@ -28,7 +28,7 @@ #include /** - * \ingroup flame + * \ingroup mesh * \defgroup flame FLAME * * \brief Forwarding LAyer for MEshing protocol diff --git a/src/mesh/test/dot11s/dot11s-test-suite.cc b/src/mesh/test/dot11s/dot11s-test-suite.cc index 48a7accb5..f57b8d1b3 100644 --- a/src/mesh/test/dot11s/dot11s-test-suite.cc +++ b/src/mesh/test/dot11s/dot11s-test-suite.cc @@ -30,8 +30,8 @@ using namespace ns3; using namespace dot11s; /** - * \ingroup dot11s-test - * \defgroup dot11s-test mesh module tests + * \ingroup mesh-test + * \defgroup dot11s-test dot11s sub-module tests */ @@ -39,7 +39,7 @@ using namespace dot11s; * \ingroup dot11s-test * \ingroup tests * - * \brief Built-in self test for FlameHeader + * \brief Built-in self test for MeshHeader */ struct MeshHeaderTest : public TestCase { diff --git a/src/mesh/test/flame/flame-regression.h b/src/mesh/test/flame/flame-regression.h index 08e1439ad..05e209d1e 100644 --- a/src/mesh/test/flame/flame-regression.h +++ b/src/mesh/test/flame/flame-regression.h @@ -25,6 +25,12 @@ #include "ns3/pcap-file.h" using namespace ns3; + +/** + * \ingroup mesh-test + * \defgroup flame-test flame sub-module tests + */ + /** * \ingroup flame-test * \ingroup tests 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 baccac3d8..93ffa1d16 100644 --- a/src/mesh/test/mesh-information-element-vector-test-suite.cc +++ b/src/mesh/test/mesh-information-element-vector-test-suite.cc @@ -34,6 +34,11 @@ using namespace ns3; +/** + * \ingroup mesh + * \defgroup mesh-test mesh module tests + */ + /** * \ingroup mesh-test * \ingroup tests diff --git a/src/mobility/test/geo-to-cartesian-test.cc b/src/mobility/test/geo-to-cartesian-test.cc index 06022c93d..5995a45ee 100644 --- a/src/mobility/test/geo-to-cartesian-test.cc +++ b/src/mobility/test/geo-to-cartesian-test.cc @@ -22,18 +22,6 @@ #include #include -/** - * This test verifies the accuracy of the GeographicToCartesianCoordinates() - * method in the GeographicPositions class, which converts earth - * geographic/geodetic coordinates to ECEF Cartesian coordinates. To do so, it - * compares the values generated from the method to values generated from the - * MATLAB function geodetic2ecef(), which is part of the MATLAB Mapping Toolbox, - * using the built-in earth referenceSphere, GRS80 referenceEllipsoid, and WGS84 - * referenceEllipsoid in MATLAB. A description of the MATLAB function can be - * found at this webpage: http://www.mathworks.com/help/map/ref/geodetic2ecef.html - * Values are compared using 216 test cases for each of the three earth spheroid - * models. - */ NS_LOG_COMPONENT_DEFINE ("GeoToCartesianTest"); using namespace ns3; @@ -487,7 +475,7 @@ const double ZWGS84_MATLAB[216] = {0, 0, 0, 0, 0, 0, 6043686.27224277, /** - * \ingroup mobility-test + * \ingroup mobility * \defgroup mobility-test mobility module tests */ @@ -497,6 +485,17 @@ const double ZWGS84_MATLAB[216] = {0, 0, 0, 0, 0, 0, 6043686.27224277, * \ingroup tests * * \brief Geo To Cartesian Test Case + * + * This test verifies the accuracy of the GeographicToCartesianCoordinates() + * method in the GeographicPositions class, which converts earth + * geographic/geodetic coordinates to ECEF Cartesian coordinates. To do so, it + * compares the values generated from the method to values generated from the + * MATLAB function geodetic2ecef(), which is part of the MATLAB Mapping Toolbox, + * using the built-in earth referenceSphere, GRS80 referenceEllipsoid, and WGS84 + * referenceEllipsoid in MATLAB. A description of the MATLAB function can be + * found at this webpage: http://www.mathworks.com/help/map/ref/geodetic2ecef.html + * Values are compared using 216 test cases for each of the three earth spheroid + * models. */ class GeoToCartesianTestCase : public TestCase { diff --git a/src/netanim/test/netanim-test.cc b/src/netanim/test/netanim-test.cc index 83c7ea76e..443d5c3b4 100644 --- a/src/netanim/test/netanim-test.cc +++ b/src/netanim/test/netanim-test.cc @@ -33,7 +33,7 @@ using namespace ns3; /** - * \ingroup netanim-test + * \ingroup netanim * \defgroup netanim-test animation module tests */ 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 8be49990b..2dc171b2b 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,7 +31,7 @@ using namespace ns3; /** - * \ingroup traffic-control-test + * \ingroup traffic-control * \defgroup traffic-control-test traffic-control module tests */ diff --git a/src/uan/test/uan-energy-model-test.cc b/src/uan/test/uan-energy-model-test.cc index faaedf47a..7db59b208 100644 --- a/src/uan/test/uan-energy-model-test.cc +++ b/src/uan/test/uan-energy-model-test.cc @@ -41,7 +41,7 @@ using namespace ns3; NS_LOG_COMPONENT_DEFINE ("UanEnergyModelTestSuite"); /** - * \ingroup uan-test + * \ingroup uan * \defgroup uan-test uan module tests */ diff --git a/src/wifi/test/80211b.c b/src/wifi/test/80211b.c index 96b9aa36a..115fa8b5c 100644 --- a/src/wifi/test/80211b.c +++ b/src/wifi/test/80211b.c @@ -47,7 +47,7 @@ #define WLAN_SIR_impossible 0.1 // if SIR < -10dB, impossible to receive /** - * \ingroup wifi-test + * \ingroup wifi * \defgroup wifi-test wifi module tests */ diff --git a/src/wimax/test/mac-messages-test.cc b/src/wimax/test/mac-messages-test.cc index 84c084901..9d7c25653 100644 --- a/src/wimax/test/mac-messages-test.cc +++ b/src/wimax/test/mac-messages-test.cc @@ -25,7 +25,7 @@ using namespace ns3; /** - * \ingroup wimax-test + * \ingroup wimax * \defgroup wimax-test wimax module tests */