documentation: various test grouping fixes

This commit is contained in:
Tommaso Pecorella
2017-04-28 02:29:26 +02:00
parent 855987401e
commit 8cfc0f1b40
10 changed files with 32 additions and 22 deletions

View File

@@ -28,7 +28,7 @@
#include <map>
/**
* \ingroup flame
* \ingroup mesh
* \defgroup flame FLAME
*
* \brief Forwarding LAyer for MEshing protocol

View File

@@ -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
{

View File

@@ -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

View File

@@ -34,6 +34,11 @@
using namespace ns3;
/**
* \ingroup mesh
* \defgroup mesh-test mesh module tests
*/
/**
* \ingroup mesh-test
* \ingroup tests

View File

@@ -22,18 +22,6 @@
#include <ns3/log.h>
#include <ns3/geographic-positions.h>
/**
* 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
{

View File

@@ -33,7 +33,7 @@
using namespace ns3;
/**
* \ingroup netanim-test
* \ingroup netanim
* \defgroup netanim-test animation module tests
*/

View File

@@ -31,7 +31,7 @@
using namespace ns3;
/**
* \ingroup traffic-control-test
* \ingroup traffic-control
* \defgroup traffic-control-test traffic-control module tests
*/

View File

@@ -41,7 +41,7 @@ using namespace ns3;
NS_LOG_COMPONENT_DEFINE ("UanEnergyModelTestSuite");
/**
* \ingroup uan-test
* \ingroup uan
* \defgroup uan-test uan module tests
*/

View File

@@ -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
*/

View File

@@ -25,7 +25,7 @@
using namespace ns3;
/**
* \ingroup wimax-test
* \ingroup wimax
* \defgroup wimax-test wimax module tests
*/