doc: fix doxygen grouping

2024-02-03 23:00:01 -06:00
parent f2d07f0a19
commit 47768894aa
63 changed files with 257 additions and 129 deletions
--- a/src/aodv/examples/aodv.cc
+++ b/src/aodv/examples/aodv.cc
@@ -33,6 +33,12 @@

 using namespace ns3;

+/**
+ * \defgroup aodv-examples AODV Examples
+ * \ingroup aodv
+ * \ingroup examples
+ */
+
 /**
 * \ingroup aodv-examples
 * \ingroup examples
--- a/src/buildings/helper/building-container.h
+++ b/src/buildings/helper/building-container.h
@@ -30,6 +30,8 @@ namespace ns3
 {

 /**
+ * \ingroup buildings
+ *
 * \brief keep track of a set of building pointers.
 *
 * Some ns-3 helpers operate on more than one building at a time.  For example
--- a/src/buildings/helper/building-position-allocator.h
+++ b/src/buildings/helper/building-position-allocator.h
@@ -32,6 +32,8 @@ class Building;
 class UniformRandomVariable;

 /**
+ * \ingroup buildings
+ *
 * Allocate each position by randomly choosing a building from the list
 * of all buildings, and then randomly choosing a position inside the building.
 */
--- a/src/buildings/helper/buildings-helper.h
+++ b/src/buildings/helper/buildings-helper.h
@@ -34,6 +34,8 @@ class MobilityModel;
 class Building;

 /**
+ * \ingroup buildings
+ *
 * Helper used to install a MobilityBuildingInfo into a set of nodes.
 */
 class BuildingsHelper
--- a/src/buildings/model/building-list.h
+++ b/src/buildings/model/building-list.h
@@ -32,6 +32,8 @@ namespace ns3
 class Building;

 /**
+ * \ingroup buildings
+ *
 * Container for Building class
 */
 class BuildingList
--- a/src/buildings/model/building.h
+++ b/src/buildings/model/building.h
@@ -31,7 +31,13 @@ namespace ns3
 {

 /**
- * \ingroup mobility
+ * \defgroup buildings Buildings
+ *
+ * The models to define 3d buildings, associated channel models, and mobility.
+ */
+
+/**
+ * \ingroup buildings
 * \brief a 3d building block
 */
 class Building : public Object
--- a/src/buildings/model/buildings-channel-condition-model.h
+++ b/src/buildings/model/buildings-channel-condition-model.h
@@ -30,6 +30,7 @@ class MobilityModel;

 /**
 * \ingroup buildings
+ * \ingroup propagation
 *
 * \brief Determines the channel condition based on the buildings deployed in the
 * scenario
--- a/src/buildings/model/buildings-propagation-loss-model.h
+++ b/src/buildings/model/buildings-propagation-loss-model.h
@@ -36,6 +36,7 @@ class ShadowingLossModel;
 class JakesFadingLossModel;

 /**
+ * \ingroup buildings
 * \ingroup propagation
 *
 *  This model provides means for simulating the following propagation
--- a/src/buildings/model/hybrid-buildings-propagation-loss-model.h
+++ b/src/buildings/model/hybrid-buildings-propagation-loss-model.h
@@ -36,6 +36,7 @@ class ItuR1238PropagationLossModel;
 class Kun2600MhzPropagationLossModel;

 /**
+ * \ingroup buildings
 * \ingroup propagation
 *
 *  \brief The HybridBuildingsPropagationModel is a compound of different models able to evaluate
--- a/src/buildings/model/itu-r-1238-propagation-loss-model.h
+++ b/src/buildings/model/itu-r-1238-propagation-loss-model.h
@@ -29,6 +29,9 @@ namespace ns3
 {

 /**
+ * \ingroup buildings
+ * \ingroup propagation
+ *
 * This class implements the ITU-R 1238 propagation loss model.
 *
 */
--- a/src/buildings/model/mobility-building-info.h
+++ b/src/buildings/model/mobility-building-info.h
@@ -36,6 +36,8 @@ namespace ns3

 /**
 * \ingroup buildings
+ * \ingroup mobility
+
 * \brief mobility buildings information (to be used by mobility models)
 *
 * This model implements the management of scenarios where users might be
--- a/src/buildings/model/oh-buildings-propagation-loss-model.h
+++ b/src/buildings/model/oh-buildings-propagation-loss-model.h
@@ -29,6 +29,7 @@ namespace ns3
 class OkumuraHataPropagationLossModel;

 /**
+ * \ingroup buildings
 * \ingroup propagation
 *
 *  this model combines the OkumuraHata model with the BuildingsPropagationLossModel
--- a/src/buildings/model/random-walk-2d-outdoor-mobility-model.h
+++ b/src/buildings/model/random-walk-2d-outdoor-mobility-model.h
@@ -36,7 +36,9 @@ namespace ns3
 {

 /**
+ * \ingroup buildings
 * \ingroup mobility
+ *
 * \brief 2D random walk mobility model which avoids buildings.
 *
 * This class reuses most of the code of RandomWalk2dMobilityModel,
--- a/src/buildings/model/three-gpp-v2v-channel-condition-model.h
+++ b/src/buildings/model/three-gpp-v2v-channel-condition-model.h
@@ -33,6 +33,7 @@ class MobilityModel;

 /**
 * \ingroup buildings
+ * \ingroup propagation
 *
 * \brief Computes the channel condition for the V2V Urban scenario
 *
--- a/src/buildings/test/building-position-allocator-test.cc
+++ b/src/buildings/test/building-position-allocator-test.cc
@@ -35,13 +35,13 @@ using namespace ns3;
 NS_LOG_COMPONENT_DEFINE("BuildingPositionAllocatorTest");

 /**
- * \ingroup propagation
+ * \ingroup buildings
+ * \ingroup tests
 * \defgroup building-test Buildings module tests
 */

 /**
 * \ingroup building-test
- * \ingroup tests
 *
 * Room coordinates
 */
@@ -75,7 +75,6 @@ operator<(const Room& a, const Room& b)

 /**
 * \ingroup building-test
- * \ingroup tests
 *
 * RandomRoomPositionAllocator test
 */
@@ -153,7 +152,6 @@ RandomRoomPositionAllocatorTestCase::DoRun()

 /**
 * \ingroup building-test
- * \ingroup tests
 *
 * SameRoomPositionAllocator test
 */
@@ -227,7 +225,6 @@ SameRoomPositionAllocatorTestCase::DoRun()

 /**
 * \ingroup building-test
- * \ingroup tests
 *
 * \brief RandomRoomPositionAllocator TestSuite
 */
--- a/src/buildings/test/buildings-channel-condition-model-test.cc
+++ b/src/buildings/test/buildings-channel-condition-model-test.cc
@@ -31,7 +31,6 @@ NS_LOG_COMPONENT_DEFINE("BuildingsChannelConditionModelsTest");

 /**
 * \ingroup building-test
- * \ingroup tests
 *
 * Test case for the class BuildingsChannelConditionModel. It checks if the
 * channel condition is correctly determined when a building is deployed in the
@@ -148,7 +147,6 @@ BuildingsChannelConditionModelTestCase::DoRun()

 /**
 * \ingroup building-test
- * \ingroup tests
 * Test suite for the buildings channel condition model
 */
 class BuildingsChannelConditionModelsTestSuite : public TestSuite
--- a/src/buildings/test/buildings-helper-test.cc
+++ b/src/buildings/test/buildings-helper-test.cc
@@ -32,7 +32,6 @@ NS_LOG_COMPONENT_DEFINE("BuildingsHelperTest");

 /**
 * \ingroup building-test
- * \ingroup tests
 *
 * \brief Struct representing a position in a building
 */
@@ -59,7 +58,6 @@ PositionInBuilding::PositionInBuilding()

 /**
 * \ingroup building-test
- * \ingroup tests

 * Data to construct a Building object. We don't want to pass Building
 * objects to the TestCase constructor because otherwise BuildingList
@@ -96,7 +94,6 @@ BuildingData::BuildingData()

 /**
 * \ingroup building-test
- * \ingroup tests
 *
 * \brief BuildingsHelper test
 */
@@ -197,7 +194,6 @@ BuildingsHelperOneTestCase::DoRun()

 /**
 * \ingroup building-test
- * \ingroup tests
 *
 * \brief BuildingsHelper TestSuite
 */
--- a/src/buildings/test/buildings-pathloss-test.h
+++ b/src/buildings/test/buildings-pathloss-test.h
@@ -27,7 +27,6 @@ using namespace ns3;

 /**
 * \ingroup building-test
- * \ingroup tests
 *
 * Test 1.1 BuildingsPathlossModel Pathloss compound test
 *
@@ -42,7 +41,6 @@ class BuildingsPathlossTestSuite : public TestSuite

 /**
 * \ingroup building-test
- * \ingroup tests
 *
 * Test 1.1 BuildingsPathlossModel Pathloss test
 *
--- a/src/buildings/test/buildings-shadowing-test.h
+++ b/src/buildings/test/buildings-shadowing-test.h
@@ -32,7 +32,6 @@ using namespace ns3;

 /**
 * \ingroup building-test
- * \ingroup tests
 *
 * Shadowing compound test
 *
@@ -47,7 +46,6 @@ class BuildingsShadowingTestSuite : public TestSuite

 /**
 * \ingroup building-test
- * \ingroup tests
 *
 * Shadowing test
 */
--- a/src/buildings/test/outdoor-random-walk-test.cc
+++ b/src/buildings/test/outdoor-random-walk-test.cc
@@ -35,7 +35,6 @@ NS_LOG_COMPONENT_DEFINE("OutdoorRandomWalkTest");

 /**
 * \ingroup building-test
- * \ingroup tests
 *
 * Test case for the class OutdoorRandomWalkTestCase. It checks if the
 * positions visited by the user are outside buildings
@@ -164,7 +163,6 @@ OutdoorRandomWalkTestCase::DoRun()

 /**
 * \ingroup building-test
- * \ingroup tests
 *
 * Test suite for the buildings channel condition model
 */
--- a/src/buildings/test/three-gpp-v2v-channel-condition-model-test.cc
+++ b/src/buildings/test/three-gpp-v2v-channel-condition-model-test.cc
@@ -38,7 +38,6 @@ NS_LOG_COMPONENT_DEFINE("ThreeGppV2vChannelConditionModelsTest");

 /**
 * \ingroup building-test
- * \ingroup tests
 *
 * Test case for the classes ThreeGppV2vUrbanChannelConditionModel,
 * and ThreeGppV2vHighwayChannelConditionModel to test their code to
@@ -511,7 +510,6 @@ ThreeGppV2vHighwayLosNlosvChCondModelTestCase::DoRun()

 /**
 * \ingroup building-test
- * \ingroup tests
 *
 * Test suite for the 3GPP V2V channel condition model
 *
--- a/src/click/test/ipv4-click-routing-test.cc
+++ b/src/click/test/ipv4-click-routing-test.cc
@@ -30,6 +30,11 @@

 using namespace ns3;

+/**
+ * \ingroup click
+ * \defgroup click-tests click module tests
+ */
+
 /**
 * \file
 * \ingroup click-tests
@@ -37,6 +42,7 @@ using namespace ns3;
 */

 /**
+ * \ingroup click-tests
 * Add Click Internet stack.
 *
 * \param node Node.
@@ -50,6 +56,7 @@ AddClickInternetStack(Ptr<Node> node)
 }

 /**
+ * \ingroup click-tests
 * Add network device.
 *
 * \param node Node.
--- a/src/config-store/examples/config-store-save.cc
+++ b/src/config-store/examples/config-store-save.cc
@@ -6,8 +6,13 @@
 using namespace ns3;

 /**
- * \ingroup configstore-examples
+ * \defgroup configstore-examples Config Store examples
+ * \ingroup configstore
 * \ingroup examples
+ */
+
+/**
+ * \ingroup configstore-examples
 *
 * \brief Example class to demonstrate use of the ns-3 Config Store
 */
--- a/src/core/examples/empirical-random-variable-example.cc
+++ b/src/core/examples/empirical-random-variable-example.cc
@@ -29,9 +29,13 @@
 #include <map>

 /**
- * \file
- * \ingroup core-examples randomvariable
 * \defgroup empirical-rng-example Core example: Empirical random variables use.
+ * \ingroup core-examples randomvariable
+ */
+
+/**
+ * \file
+ * \ingroup empirical-rng-example
 *
 * Example program illustrating use of ns3::EmpiricalRandomVariable
 *
--- a/src/core/helper/csv-reader.cc
+++ b/src/core/helper/csv-reader.cc
@@ -31,7 +31,6 @@

 /**
 * \file
- * \ingroup core
 * \ingroup csvreader
 *
 * ns3::CsvReader implementation
--- a/src/core/helper/csv-reader.h
+++ b/src/core/helper/csv-reader.h
@@ -29,7 +29,6 @@

 /**
 * \file
- * \ingroup core
 * \ingroup csvreader
 *
 * ns3::CsvReader declaration
--- a/src/core/model/attribute-container.h
+++ b/src/core/model/attribute-container.h
@@ -34,10 +34,18 @@
 namespace ns3
 {

+/*!
+ * \ingroup attributes
+ * \addtogroup attribute_AttributeContainer AttributeContainer Attribute
+ * AttributeValue implementation for AttributeContainer
+ */
+
 class AttributeChecker;

 // A = attribute value type, C = container type to return
 /**
+ * \ingroup attribute_AttributeContainer
+ *
 * A container for one type of attribute.
 *
 * The container uses \p A to parse items into elements.
@@ -191,6 +199,13 @@ class AttributeContainerValue : public AttributeValue
    container_type m_container; //!< Internal container
 };

+/*!
+ * \ingroup attribute_AttributeContainer
+ *
+ * \class  ns3::AttributeContainerChecker "attribute-container.h"
+ * AttributeChecker implementation for AttributeContainerValue.
+ * \see AttributeChecker
+ */
 class AttributeContainerChecker : public AttributeChecker
 {
  public:
@@ -207,6 +222,8 @@ class AttributeContainerChecker : public AttributeChecker
 };

 /**
+ * \ingroup attribute_AttributeContainer
+ *
 * Make AttributeContainerChecker from AttributeContainerValue.
 * @tparam A \deduced AttributeValue type in container.
 * @tparam Sep \deduced Character separator between elements for parsing.
@@ -219,6 +236,8 @@ Ptr<AttributeChecker> MakeAttributeContainerChecker(
    const AttributeContainerValue<A, Sep, C>& value);

 /**
+ * \ingroup attribute_AttributeContainer
+ *
 * Make AttributeContainerChecker using explicit types, initialize item checker.
 * @tparam A AttributeValue type in container.
 * @tparam Sep Character separator between elements for parsing.
@@ -230,6 +249,8 @@ template <class A, char Sep = ',', template <class...> class C = std::list>
 Ptr<const AttributeChecker> MakeAttributeContainerChecker(Ptr<const AttributeChecker> itemchecker);

 /**
+ * \ingroup attribute_AttributeContainer
+ *
 * Make uninitialized AttributeContainerChecker using explicit types.
 * @tparam A AttributeValue type in container.
 * @tparam Sep Character separator between elements for parsing.
@@ -240,6 +261,8 @@ template <class A, char Sep = ',', template <class...> class C = std::list>
 Ptr<AttributeChecker> MakeAttributeContainerChecker();

 /**
+ * \ingroup attribute_AttributeContainer
+ *
 * Make AttributeContainerAccessor  using explicit types.
 * @tparam A AttributeValue type in container.
 * @tparam Sep Character separator between elements for parsing.
@@ -254,6 +277,8 @@ template <typename A, char Sep = ',', template <typename...> class C = std::list
 Ptr<const AttributeAccessor> MakeAttributeContainerAccessor(T1 a1);

 /**
+ * \ingroup attribute_AttributeContainer
+ *
 * Make AttributeContainerAccessor  using explicit types.
 * @tparam A AttributeValue type in container.
 * @tparam Sep Character separator between elements for parsing.
@@ -287,7 +312,10 @@ namespace internal
 {

 /**
+ * \ingroup attribute_AttributeContainer
+ *
 * \internal
+ *
 * Templated AttributeContainerChecker class that is instantiated
 * in MakeAttributeContainerChecker. The non-templated base ns3::AttributeContainerChecker
 * is returned from that function. This is the same pattern as ObjectPtrContainer.
--- a/src/core/model/config.cc
+++ b/src/core/model/config.cc
@@ -30,10 +30,14 @@

 /**
 * \file
- * \ingroup config
+ * \ingroup config-impl
 * ns3::Config implementations.
 */

+/**
+ * \defgroup config-impl Config implementations
+ * \ingroup config
+ */
 namespace ns3
 {

--- a/src/core/model/deprecated.h
+++ b/src/core/model/deprecated.h
@@ -22,12 +22,17 @@

 /**
 * \file
- * \ingroup core
+ * \ingroup deprecation
 * NS_DEPRECATED macro definition.
 */

 /**
+ * \defgroup deprecation Deprecation
 * \ingroup core
+ */
+
+/**
+ * \ingroup deprecation
 * \def NS_DEPRECATED
 * Mark a function as deprecated.
 *
@@ -75,21 +80,21 @@
 #define NS_DEPRECATED(msg) [[deprecated(msg)]]

 /**
- * \ingroup core
+ * \ingroup deprecation
 * \def NS_DEPRECATED_3_42
 * Tag for things deprecated in version ns-3.42.
 */
 #define NS_DEPRECATED_3_42(msg) NS_DEPRECATED(msg)

 /**
- * \ingroup core
+ * \ingroup deprecation
 * \def NS_DEPRECATED_3_41
 * Tag for things deprecated in version ns-3.41.
 */
 #define NS_DEPRECATED_3_41(msg) NS_DEPRECATED(msg)

 /**
- * \ingroup core
+ * \ingroup deprecation
 * \def NS_DEPRECATED_3_40
 * Tag for things deprecated in version ns-3.40.
 */
--- a/src/core/model/global-value.h
+++ b/src/core/model/global-value.h
@@ -41,7 +41,7 @@ class GlobalValueTestCase;
 }

 /**
- * \ingroup Core
+ * \ingroup core
 *
 * \brief Hold a so-called 'global value'.
 *
--- a/src/core/model/nstime.h
+++ b/src/core/model/nstime.h
@@ -1414,9 +1414,9 @@ ATTRIBUTE_VALUE_DEFINE(Time);
 ATTRIBUTE_ACCESSOR_DEFINE(Time);

 /**
- *  \ingroup attribute_time
- *  Helper to make a Time checker with bounded range.
- *  Both limits are inclusive
+ * \ingroup attribute_Time
+ * Helper to make a Time checker with bounded range.
+ * Both limits are inclusive
 *
 * \param [in] min Minimum allowed value.
 * \param [in] max Maximum allowed value.
@@ -1425,7 +1425,7 @@ ATTRIBUTE_ACCESSOR_DEFINE(Time);
 Ptr<const AttributeChecker> MakeTimeChecker(const Time min, const Time max);

 /**
- * \ingroup attribute_time
+ * \ingroup attribute_Time
 * Helper to make an unbounded Time checker.
 *
 * \return The AttributeChecker
@@ -1437,7 +1437,7 @@ MakeTimeChecker()
 }

 /**
- * \ingroup attribute_time
+ * \ingroup attribute_Time
 * Helper to make a Time checker with a lower bound.
 *
 * \param [in] min Minimum allowed value.
--- a/src/core/model/object-ptr-container.h
+++ b/src/core/model/object-ptr-container.h
@@ -31,6 +31,11 @@
 * ns3::ObjectPtrContainerValue attribute value declarations and template implementations.
 */

+/**
+ * \ingroup attributes
+ * \defgroup attribute_ObjectPtrContainer ObjectPtrContainer Attribute
+ * AttributeValue implementation for ObjectPtrContainer
+ */
 namespace ns3
 {

@@ -41,6 +46,12 @@ namespace ns3
 *
 * This class it used to get attribute access to an array of
 * ns3::Object pointers.
+ *
+ * \see AttributeValue
+ *
+ * Call graph was not generated because of its size.
+ * \hidecallergraph
+ * \hidecallgraph
 */
 class ObjectPtrContainerValue : public AttributeValue
 {
@@ -146,6 +157,12 @@ template <typename T, typename U, typename INDEX>
 Ptr<const AttributeAccessor> MakeObjectPtrContainerAccessor(INDEX (T::*getN)() const,
                                                            Ptr<U> (T::*get)(INDEX) const);

+/**
+ * \ingroup attribute_ObjectPtrContainer
+ *
+ * AttributeChecker implementation for ObjectPtrContainerValue.
+ * \see AttributeChecker
+ */
 class ObjectPtrContainerChecker : public AttributeChecker
 {
  public:
@@ -156,22 +173,28 @@ class ObjectPtrContainerChecker : public AttributeChecker
    virtual TypeId GetItemTypeId() const = 0;
 };

+/**
+ * \ingroup attribute_ObjectPtrContainer
+ * \returns The AttributeChecker.
+ * \see AttributeChecker
+ */
 template <typename T>
 Ptr<const AttributeChecker> MakeObjectPtrContainerChecker();

 } // namespace ns3

-/***************************************************************
- *        The implementation of the above functions.
- ***************************************************************/
+//
+// The implementation of the above functions.
+//

 namespace ns3
 {

 namespace internal
 {
-
-/** ObjectPtrContainerChecker implementation class. */
+/**
+ * ObjectPtrContainerChecker implementation class.
+ */
 template <typename T>
 class ObjectPtrContainerChecker : public ns3::ObjectPtrContainerChecker
 {
--- a/src/core/model/scheduler.h
+++ b/src/core/model/scheduler.h
@@ -229,7 +229,7 @@ class Scheduler : public Object
 };

 /**
- * \ingroup Events
+ * \ingroup events
 * Compare (equal) two events by EventKey.
 *
 * \param [in] a The first event.
@@ -243,7 +243,7 @@ operator==(const Scheduler::EventKey& a, const Scheduler::EventKey& b)
 }

 /**
- * \ingroup Events
+ * \ingroup events
 * Compare (not equal) two events by EventKey.
 *
 * \param [in] a The first event.
@@ -257,7 +257,7 @@ operator!=(const Scheduler::EventKey& a, const Scheduler::EventKey& b)
 }

 /**
- * \ingroup Events
+ * \ingroup events
 * Compare (less than) two events by EventKey.
 *
 * Note the invariants which this function must provide:
--- a/src/core/model/simulation-singleton.h
+++ b/src/core/model/simulation-singleton.h
@@ -21,7 +21,7 @@

 /**
 * \file
- * \ingroup core
+ * \ingroup singleton
 * ns3::SimulationSingleton declaration and template implementation.
 */

@@ -29,7 +29,7 @@ namespace ns3
 {

 /**
- * \ingroup core
+ * \ingroup singleton
 * This singleton class template ensures that the type
 * for which we want a singleton has a lifetime bounded
 * by the simulation run lifetime. That it, the underlying
--- a/src/core/model/singleton.h
+++ b/src/core/model/singleton.h
@@ -21,7 +21,7 @@

 /**
 * \file
- * \ingroup access
+ * \ingroup singleton
 * ns3::Singleton declaration and template implementation.
 */

@@ -29,7 +29,14 @@ namespace ns3
 {

 /**
- * \ingroup access
+ * \ingroup core
+ * \defgroup singleton Singleton
+ *
+ * Template class implementing the Singleton design pattern.
+ */
+
+/**
+ * \ingroup singleton
 * \brief A template singleton
 *
 * This template class can be used to implement the singleton pattern.
--- a/src/core/model/val-array.h
+++ b/src/core/model/val-array.h
@@ -29,6 +29,11 @@
 namespace ns3
 {

+/**
+ * \defgroup Matrices Classes to do efficient math operations on arrays
+ * \ingroup core
+ */
+
 /**
 * \ingroup Matrices
 *
--- a/src/core/model/warnings.h
+++ b/src/core/model/warnings.h
@@ -21,28 +21,35 @@
 #define NS3_WARNINGS_H

 /**
+ * \defgroup warnings Compiler warnings
 * \ingroup core
+ *
+ * Macros useful to silence compiler warnings on selected code parts.
+ */
+
+/**
+ * \ingroup warnings
 * \def NS_WARNING_POP
 * Pops the diagnostic warning list from the stack, restoring it to the previous state.
 * \sa NS_WARNING_PUSH
 */

 /**
- * \ingroup core
+ * \ingroup warnings
 * \def NS_WARNING_PUSH
 * Push the diagnostic warning list to the stack, allowing it to be restored later.
 * \sa NS_WARNING_POP
 */

 /**
- * \ingroup core
+ * \ingroup warnings
 * \def NS_WARNING_SILENCE_DEPRECATED
 * Silences the "-Wdeprecated-declarations" warnings.
 * \sa NS_WARNING_POP
 */

 /**
- * \ingroup core
+ * \ingroup warnings
 * \def NS_WARNING_PUSH_DEPRECATED
 * Save the current warning list and disables the ones about deprecated functions and classes.
 *
--- a/src/core/test/event-garbage-collector-test-suite.cc
+++ b/src/core/test/event-garbage-collector-test-suite.cc
@@ -24,7 +24,7 @@
 * \file
 * \ingroup core-tests
 * \ingroup events
- * \ingroup events-garbage-tests
+ * \ingroup event-garbage-tests
 * EventGarbageCollector test suite.
 */

--- a/src/core/test/examples-as-tests-test-suite.cc
+++ b/src/core/test/examples-as-tests-test-suite.cc
@@ -32,6 +32,7 @@ using namespace ns3;

 /**
 * \ingroup core-tests
+ * \ingroup testing
 * \defgroup examples-as-tests Examples as tests test suite
 *
 * Runs several examples as tests in order to test ExampleAsTestSuite and ExampleAsTestCase.
@@ -114,14 +115,14 @@ ExamplesAsTestsTestSuite::ExamplesAsTestsTestSuite()
 }

 /**
- * \ingroup examples-tests
+ * \ingroup examples-as-tests
 * ExampleAsTestsTestSuite instance variable.
 * Tests multiple examples in a single TestSuite using AddTestCase to add the examples to the suite.
 */
 static ExamplesAsTestsTestSuite g_examplesAsTestsTestSuite;

 /**
- * \ingroup examples-tests
+ * \ingroup examples-as-tests
 * ExampleTestSuite instance variables.
 *
 * Tests ExampleTestSuite which runs a single example as test suite as specified in constructor
--- a/src/core/test/many-uniform-random-variables-one-get-value-call-test-suite.cc
+++ b/src/core/test/many-uniform-random-variables-one-get-value-call-test-suite.cc
@@ -28,7 +28,7 @@
 * \file
 * \ingroup core-tests
 * \ingroup randomvariable
- * \ingroup randomvariable-tests
+ * \ingroup rng-tests
 * Test for many uniform random variable streams.
 */

@@ -39,15 +39,13 @@ namespace tests
 {

 /**
- * \ingroup randomvariable-tests
+ * \ingroup rng-tests
 * Test case for many uniform distribution random variable stream generators
 */
 class ManyUniformRandomVariablesOneGetValueCallTestCase : public TestCase
 {
  public:
-    /** Constructor. */
    ManyUniformRandomVariablesOneGetValueCallTestCase();
-    /** Destructor. */
    ~ManyUniformRandomVariablesOneGetValueCallTestCase() override;

  private:
@@ -89,13 +87,12 @@ ManyUniformRandomVariablesOneGetValueCallTestCase::DoRun()
 }

 /**
- * \ingroup randomvariable-tests
+ * \ingroup rng-tests
 * Test suite for many uniform distribution random variable stream generators
 */
 class ManyUniformRandomVariablesOneGetValueCallTestSuite : public TestSuite
 {
  public:
-    /** Constructor. */
    ManyUniformRandomVariablesOneGetValueCallTestSuite();
 };

@@ -107,7 +104,7 @@ ManyUniformRandomVariablesOneGetValueCallTestSuite::
 }

 /**
- * \ingroup randomvariable-tests
+ * \ingroup rng-tests
 * ManuUniformRandomVariablesOneGetValueCallTestSuite instance variable.
 */
 static ManyUniformRandomVariablesOneGetValueCallTestSuite
--- a/src/core/test/matrix-array-test-suite.cc
+++ b/src/core/test/matrix-array-test-suite.cc
@@ -22,9 +22,13 @@
 #include "ns3/test.h"

 /**
- * \file
+ * \defgroup matrixArray-tests MatrixArray tests
 * \ingroup core-tests
- * \ingroup matrixArray
+ * \ingroup Matrices
+ */
+
+/**
+ * \file
 * \ingroup matrixArray-tests
 * MatrixArray test suite
 */
--- a/src/core/test/one-uniform-random-variable-many-get-value-calls-test-suite.cc
+++ b/src/core/test/one-uniform-random-variable-many-get-value-calls-test-suite.cc
@@ -28,7 +28,7 @@
 * \file
 * \ingroup core-tests
 * \ingroup randomvariable
- * \ingroup randomvariable-tests
+ * \ingroup rng-tests
 * Test for one uniform random variable stream.
 */

@@ -39,15 +39,13 @@ namespace tests
 {

 /**
- * \ingroup randomvariable-tests
+ * \ingroup rng-tests
 * Test case for one uniform distribution random variable stream generator
 */
 class OneUniformRandomVariableManyGetValueCallsTestCase : public TestCase
 {
  public:
-    /** Constructor. */
    OneUniformRandomVariableManyGetValueCallsTestCase();
-    /** Destructor. */
    ~OneUniformRandomVariableManyGetValueCallsTestCase() override;

  private:
@@ -89,13 +87,12 @@ OneUniformRandomVariableManyGetValueCallsTestCase::DoRun()
 }

 /**
- * \ingroup randomvariable-tests
+ * \ingroup rng-tests
 * Test suite for one uniform distribution random variable stream generator
 */
 class OneUniformRandomVariableManyGetValueCallsTestSuite : public TestSuite
 {
  public:
-    /** Constructor. */
    OneUniformRandomVariableManyGetValueCallsTestSuite();
 };

@@ -107,7 +104,7 @@ OneUniformRandomVariableManyGetValueCallsTestSuite::
 }

 /**
- * \ingroup randomvariable-tests
+ * \ingroup rng-tests
 * OneUniformRandomVariableManyGetValueCallsTestSuite instance variable.
 */
 static OneUniformRandomVariableManyGetValueCallsTestSuite
--- a/src/core/test/val-array-test-suite.cc
+++ b/src/core/test/val-array-test-suite.cc
@@ -22,6 +22,19 @@
 #include "ns3/val-array.h"

 /**
+ * \defgroup valArray-tests ValArray tests
+ * \ingroup core-tests
+ * \ingroup Matrices
+ */
+
+/**
+ * \file
+ * \ingroup valArray-tests
+ * ValArray test suite
+ */
+
+/**
+ * \file
 * \ingroup core-tests
 */

@@ -33,6 +46,8 @@ namespace tests
 NS_LOG_COMPONENT_DEFINE("ValArrayTest");

 /**
+ * @ingroup valArray-tests
+ *
 * @brief ValArray test case for testing ValArray class
 *
 * @tparam T the template parameter that can be a complex number, double or int
--- a/src/dsdv/examples/dsdv-manet.cc
+++ b/src/dsdv/examples/dsdv-manet.cc
@@ -46,9 +46,13 @@ uint16_t port = 9;
 NS_LOG_COMPONENT_DEFINE("DsdvManetExample");

 /**
+ * \defgroup dsdv-examples DSDV Examples
 * \ingroup dsdv
- * \ingroup dsdv-examples
 * \ingroup examples
+ */
+
+/**
+ * \ingroup dsdv-examples
 *
 * \brief DSDV Manet example
 */
--- a/src/fd-net-device/helper/dpdk-net-device-helper.h
+++ b/src/fd-net-device/helper/dpdk-net-device-helper.h
@@ -27,10 +27,9 @@ namespace ns3
 {

 /**
- * \ingroup dpdk-net-device
+ * \ingroup fd-net-device
 * \brief build a DpdkNetDevice object attached to a physical network
 * interface
- *
 */
 class DpdkNetDeviceHelper : public EmuFdNetDeviceHelper
 {
--- a/src/internet-apps/examples/traceroute-example.cc
+++ b/src/internet-apps/examples/traceroute-example.cc
@@ -18,8 +18,6 @@
 *
 *
 * TraceRoute application example using AODV routing protocol.
- *
- *
 */

 #include "ns3/aodv-module.h"
--- a/src/internet/helper/neighbor-cache-helper.h
+++ b/src/internet/helper/neighbor-cache-helper.h
@@ -40,7 +40,7 @@ namespace ns3
 {

 /**
- * \ingroup NeighborCacheHelper
+ * \ingroup internet
 *
 * @brief A helper class to populate neighbor cache.
 *
--- a/src/internet/test/tcp-advertised-window-test.cc
+++ b/src/internet/test/tcp-advertised-window-test.cc
@@ -28,7 +28,7 @@ using namespace ns3;
 NS_LOG_COMPONENT_DEFINE("TcpAdvertisedWindowTestSuite");

 /**
- * \ingroup internet-tests
+ * \ingroup internet-test
 * \ingroup tests
 * \brief Socket that wraps every call to AdvertisedWindowSize ().
 */
@@ -206,8 +206,8 @@ TcpSocketAdvertisedWindowProxy::OldAdvertisedWindowSize(bool scale) const
 NS_OBJECT_ENSURE_REGISTERED(TcpSocketAdvertisedWindowProxy);

 /**
- * \ingroup internet-tests
- * \ingroup test
+ * \ingroup internet-test
+ * \ingroup tests
 *
 * \brief An error model that randomly drops a given rátio of TCP segments.
 */
@@ -260,8 +260,8 @@ TcpDropRatioErrorModel::ShouldDrop(const Ipv4Header& ipHeader,
 }

 /**
- * \ingroup internet-tests
- * \ingroup test
+ * \ingroup internet-test
+ * \ingroup tests
 * \brief Test the new formula for calculating TCP's advertised window size.
 *
 * In TcpSocketBase, the advertised window is now calculated as
@@ -363,8 +363,8 @@ TcpAdvertisedWindowTest::InvalidAwndCb(uint16_t oldAwnd, uint16_t newAwnd)
 //-----------------------------------------------------------------------------

 /**
- * \ingroup internet-tests
- * \ingroup test
+ * \ingroup internet-test
+ * \ingroup tests
 * \brief Test the TCP's advertised window size when there is a loss of specific packets.
 */
 class TcpAdvWindowOnLossTest : public TcpGeneralTest
@@ -464,8 +464,8 @@ TcpAdvWindowOnLossTest::InvalidAwndCb(uint16_t oldAwnd, uint16_t newAwnd)
 //-----------------------------------------------------------------------------

 /**
- * \ingroup internet-tests
- * \ingroup test
+ * \ingroup internet-test
+ * \ingroup tests
 *
 * \brief Test Suite for TCP adv window
 */
--- a/src/internet/test/tcp-rate-ops-test.cc
+++ b/src/internet/test/tcp-rate-ops-test.cc
@@ -36,7 +36,7 @@ NS_LOG_COMPONENT_DEFINE("TcpRateOpsTestSuite");
 class MimicCongControl;

 /**
- * \ingroup internet-tests
+ * \ingroup internet-test
 * \ingroup tests
 *
 * \brief The TcpRateLinux Basic Test
@@ -217,7 +217,7 @@ MimicCongControl::GetTypeId()
 }

 /**
- * \ingroup internet-tests
+ * \ingroup internet-test
 * \ingroup tests
 *
 * \brief The TcpRateLinux Test uses sender-receiver model to test its functionality.
@@ -435,7 +435,7 @@ TcpRateLinuxWithSocketsTest::FinalChecks()
 }

 /**
- * \ingroup internet-tests
+ * \ingroup internet-test
 * \ingroup tests
 *
 * \brief The TcpRateLinuxWithBufferTest tests rate sample functionality with arbitrary SACK
--- a/src/internet/test/tcp-rx-buffer-test.cc
+++ b/src/internet/test/tcp-rx-buffer-test.cc
@@ -24,7 +24,7 @@ using namespace ns3;
 NS_LOG_COMPONENT_DEFINE("TcpRxBufferTestSuite");

 /**
- * \ingroup internet-tests
+ * \ingroup internet-test
 * \ingroup tests
 *
 * \brief The TcpRxBuffer Test
--- a/src/internet/test/tcp-tx-buffer-test.cc
+++ b/src/internet/test/tcp-tx-buffer-test.cc
@@ -27,7 +27,7 @@ using namespace ns3;
 NS_LOG_COMPONENT_DEFINE("TcpTxBufferTestSuite");

 /**
- * \ingroup internet-tests
+ * \ingroup internet-test
 * \ingroup tests
 *
 * \brief The TcpTxBuffer Test
--- a/src/lr-wpan/model/lr-wpan-constants.h
+++ b/src/lr-wpan/model/lr-wpan-constants.h
@@ -34,7 +34,7 @@ namespace lrwpan
 {

 /**
- * \defgroup LrWpanConstants
+ * \defgroup LrWpanConstants LR-WPAN common parameters
 * \ingroup lr-wpan
 *
 * Contains common parameters about LR-WPAN that can be reused in multiple files.
--- a/src/lte/model/ff-mac-common.h
+++ b/src/lte/model/ff-mac-common.h
@@ -405,11 +405,13 @@ struct SpsConfig_s
 */
 struct SrConfig_s
 {
-    enum SetupRelease_e m_action
+    /// Actions
+    enum SetupRelease_e
    {
        setup
-    }; ///< action
+    };

+    SetupRelease_e m_action;            ///< action
    uint8_t m_schedInterval{UINT8_MAX}; ///< sched interval
    uint8_t m_dsrTransMax{UINT8_MAX};   ///< trans max
 };
@@ -419,11 +421,13 @@ struct SrConfig_s
 */
 struct CqiConfig_s
 {
-    enum SetupRelease_e m_action
+    /// Actions
+    enum SetupRelease_e
    {
        setup
-    }; ///< action
+    };

+    SetupRelease_e m_action;                 ///< CQI action
    uint16_t m_cqiSchedInterval{UINT16_MAX}; ///< CQI schedule interval
    uint8_t m_riSchedInterval{UINT8_MAX};    ///< RI schedule interval
 };
--- a/src/propagation/model/jakes-process.h
+++ b/src/propagation/model/jakes-process.h
@@ -31,7 +31,7 @@ class PropagationLossModel;
 class JakesPropagationLossModel;

 /**
- * \ingroup fading
+ * \ingroup propagation
 *
 * \brief Implementation for a single path Stationary Jakes propagation loss model.
 *
@@ -45,9 +45,8 @@ class JakesPropagationLossModel;
 * \f[ X_s(t) = \frac{2}{\sqrt{M}}\sum_{n=1}^{M}\sin(\psi_n)\cos(\omega_d t\cos(\alpha_n)+\phi_n)\f]
 * with
 * \f[ \alpha_n = \frac{2\pi n - \pi + \theta}{4M},  n=1,2, \ldots,M\f]
- * where
- *\f$\theta\f$, \f$\phi\f$, and \f$\psi_n\f$ are statically independent and uniformly distributed
- *over \f$[-\pi, \pi)\f$ for all \f$n\f$.
+ * where \f$\theta\f$, \f$\phi\f$, and \f$\psi_n\f$ are
+ * statically independent and uniformly distributed over \f$[-\pi, \pi)\f$ for all \f$n\f$.
 *
 *
 * [1] Y. R. Zheng and C. Xiao, "Simulation Models With Correct
--- a/src/test/ns3tcp/ns3tcp-cubic-test-suite.cc
+++ b/src/test/ns3tcp/ns3tcp-cubic-test-suite.cc
@@ -79,9 +79,7 @@ static constexpr bool WRITE_GNUPLOT = false; //!< Set to true to write out gnupl

 /**
 * \ingroup system-tests-tcp
- */
-
-/**
+ *
 * Add sample trace values to data structures
 * \param gnuplotTimeSeries Gnuplot data structure
 * \param timeSeries time series of cwnd changes
@@ -101,6 +99,7 @@ CubicCwndTracer(Gnuplot2dDataset* gnuplotTimeSeries,
 }

 /**
+ * \ingroup system-tests-tcp
 * Test Cubic response
 */
 class Ns3TcpCubicTestCase : public TestCase
@@ -403,7 +402,7 @@ Ns3TcpCubicTestCase::DoRun()
 }

 /**
- * \ingroup tcp-cubic-tests
+ * \ingroup system-tests-tcp
 * TestSuite for module tcp-cubic
 */
 class Ns3TcpCubicTestSuite : public TestSuite
@@ -461,7 +460,6 @@ Ns3TcpCubicTestSuite::Ns3TcpCubicTestSuite()
 }

 /**
- * \ingroup tcp-cubic-tests
 * Static variable for test initialization
 */
 static Ns3TcpCubicTestSuite ns3TcpCubicTestSuite;
--- a/src/uan/examples/uan-6lowpan-example.cc
+++ b/src/uan/examples/uan-6lowpan-example.cc
@@ -32,6 +32,7 @@
 using namespace ns3;

 /**
+ * \ingroup uan
 *
 * This example shows the usage of UDP over 6LoWPAN to transfer data.
 * Two nodes are sending their remaining energy percentage (1 byte)
--- a/src/uan/examples/uan-ipv4-example.cc
+++ b/src/uan/examples/uan-ipv4-example.cc
@@ -30,6 +30,7 @@
 using namespace ns3;

 /**
+ * \ingroup uan
 *
 * This example shows the usage of UDP over IPv4 to transfer data.
 * Two nodes are sending their remaining energy percentage (1 byte)
--- a/src/uan/examples/uan-ipv6-example.cc
+++ b/src/uan/examples/uan-ipv6-example.cc
@@ -30,6 +30,7 @@
 using namespace ns3;

 /**
+ * \ingroup uan
 *
 * This example shows the usage of UDP over IPv6 to transfer data.
 * Two nodes are sending their remaining energy percentage (1 byte)
--- a/src/uan/examples/uan-raw-example.cc
+++ b/src/uan/examples/uan-raw-example.cc
@@ -32,6 +32,7 @@
 using namespace ns3;

 /**
+ * \ingroup uan
 *
 * This example shows the usage of raw packets transfer data.
 * Two nodes are sending their remaining energy percentage (1 byte)
--- a/src/uan/examples/uan-rc-example.cc
+++ b/src/uan/examples/uan-rc-example.cc
@@ -19,7 +19,8 @@

 /**
 * \file uan-rc-example.cc
- * \ingroup UAN
+ * \ingroup uan
+ *
 * This example uses UanMacRc and UanMacRcGw which combined form a system
 * using what is referred to as RC-MAC.  Details of RC-MAC will be published
 * soon.  In brief terms, RC-MAC is a dual channel protocol wherein the
--- a/src/wifi/test/80211b.c
+++ b/src/wifi/test/80211b.c
@@ -17,9 +17,13 @@
 * Author: Gary Pei <guangyu.pei@boeing.com>
 */

-/*
+/**
+ * \file
+ * \ingroup wifi-test
+ * \ingroup tests
+ *
 * This program is used to generate plots found in the paper
- * G. Pei and Tom Henderson, "Validation of ns-3 802.11b PHY model",
+ * Guangyu Pei and Tom Henderson, "Validation of ns-3 802.11b PHY model",
 * available online at http://www.nsnam.org/~pei/80211b.pdf
 *
 * It can be compiled as a C program and relies on a library installation of
@@ -33,6 +37,13 @@
 *   gnuplot 80211b.plt
 */

+/**
+ * \ingroup wifi
+ * \defgroup wifi-test wifi module tests
+ */
+
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
+
 #include <gsl/gsl_cdf.h>
 #include <gsl/gsl_integration.h>
 #include <gsl/gsl_math.h>
@@ -43,17 +54,6 @@
 #define WLAN_SIR_perfect 10.0   // if SIR > 10dB, perfect reception
 #define WLAN_SIR_impossible 0.1 // if SIR < -10dB, impossible to receive

-/**
- * \ingroup wifi
- * \defgroup wifi-test wifi module tests
- */
-
-/**
- * \ingroup wifi-test
- * \ingroup tests
- *
- * \brief fn_parameter_t structure
- */
 typedef struct fn_parameter_t
 {
    double beta; ///< beta
@@ -284,3 +284,5 @@ main(int argc, char* argv[])
    }
    return 0;
 }
+
+#endif /* DOXYGEN_SHOULD_SKIP_THIS */
--- a/src/wifi/test/wifi-mac-ofdma-test.cc
+++ b/src/wifi/test/wifi-mac-ofdma-test.cc
@@ -367,7 +367,6 @@ TestMultiUserScheduler::ComputeUlMuInfo()

 /**
 * \ingroup wifi-test
- * \ingroup tests
 * The scenarios
 */
 enum class WifiOfdmaScenario : uint8_t
--- a/utils/print-introspected-doxygen.cc
+++ b/utils/print-introspected-doxygen.cc
@@ -1439,9 +1439,6 @@ PrintAttributeImplementations(std::ostream& os)
      { "Mac48Address",   "Mac48Address",   true,  "mac48-address.h"    },
      { "Mac64Address",   "Mac64Address",   true,  "mac64-address.h"    },
      { "ObjectFactory",  "ObjectFactory",  true,  "object-factory.h"   },
-      { "OrganizationIdentifier",
-                          "OrganizationIdentifier",
-                                            true,  "vendor-specific-action.h" },
      { "Priomap",        "Priomap",        true,  "prio-queue-disc.h"  },
      { "QueueSize",      "QueueSize",      true,  "queue-size.h"       },
      { "Rectangle",      "Rectangle",      true,  "rectangle.h"        },
@@ -1480,12 +1477,13 @@ PrintAttributeImplementations(std::ostream& os)
    PrintAttributeValueSection(os, "EmptyAttribute", false);
    PrintAttributeValueWithName(os, "EmptyAttribute", "EmptyAttribute", "attribute.h");

-    PrintAttributeValueSection(os, "ObjectPtrContainer", false);
-    PrintAttributeValueWithName(os,
-                                "ObjectPtrContainer",
-                                "ObjectPtrContainer",
-                                "object-ptr-container.h");
-    PrintMakeChecker(os, "ObjectPtrContainer", "object-ptr-container.h");
+    // ObjectPtrContainer is already documented.
+    // PrintAttributeValueSection(os, "ObjectPtrContainer", false);
+    // PrintAttributeValueWithName(os,
+    //                             "ObjectPtrContainer",
+    //                             "ObjectPtrContainer",
+    //                             "object-ptr-container.h");
+    // PrintMakeChecker(os, "ObjectPtrContainer", "object-ptr-container.h");

    PrintAttributeValueSection(os, "ObjectVector", false);
    PrintMakeAccessors(os, "ObjectVector");
@@ -1507,7 +1505,7 @@ PrintAttributeImplementations(std::ostream& os)
    // PrintAttributeValueSection  (os, "AttributeContainer", false);
    // PrintAttributeValueWithName (os, "AttributeContainer", "AttributeContainer",
    // "attribute-container.h");
-    PrintMakeChecker(os, "AttributeContainer", "attribute-container.h");
+    // PrintMakeChecker(os, "AttributeContainer", "attribute-container.h");
 } // PrintAttributeImplementations ()

 /***************************************************************