From 47768894aa77e90e42655eabdd7deb9496a5f06a Mon Sep 17 00:00:00 2001 From: Tommaso Pecorella Date: Sat, 3 Feb 2024 23:00:01 -0600 Subject: [PATCH] doc: fix doxygen grouping --- src/aodv/examples/aodv.cc | 6 ++++ src/buildings/helper/building-container.h | 2 ++ .../helper/building-position-allocator.h | 2 ++ src/buildings/helper/buildings-helper.h | 2 ++ src/buildings/model/building-list.h | 2 ++ src/buildings/model/building.h | 8 ++++- .../model/buildings-channel-condition-model.h | 1 + .../model/buildings-propagation-loss-model.h | 1 + .../hybrid-buildings-propagation-loss-model.h | 1 + .../model/itu-r-1238-propagation-loss-model.h | 3 ++ src/buildings/model/mobility-building-info.h | 2 ++ .../oh-buildings-propagation-loss-model.h | 1 + .../random-walk-2d-outdoor-mobility-model.h | 2 ++ .../three-gpp-v2v-channel-condition-model.h | 1 + .../test/building-position-allocator-test.cc | 7 ++-- .../buildings-channel-condition-model-test.cc | 2 -- src/buildings/test/buildings-helper-test.cc | 4 --- src/buildings/test/buildings-pathloss-test.h | 2 -- src/buildings/test/buildings-shadowing-test.h | 2 -- .../test/outdoor-random-walk-test.cc | 2 -- ...ee-gpp-v2v-channel-condition-model-test.cc | 2 -- src/click/test/ipv4-click-routing-test.cc | 7 ++++ .../examples/config-store-save.cc | 7 +++- .../empirical-random-variable-example.cc | 8 +++-- src/core/helper/csv-reader.cc | 1 - src/core/helper/csv-reader.h | 1 - src/core/model/attribute-container.h | 28 ++++++++++++++++ src/core/model/config.cc | 6 +++- src/core/model/deprecated.h | 13 +++++--- src/core/model/global-value.h | 2 +- src/core/model/nstime.h | 10 +++--- src/core/model/object-ptr-container.h | 33 ++++++++++++++++--- src/core/model/scheduler.h | 6 ++-- src/core/model/simulation-singleton.h | 4 +-- src/core/model/singleton.h | 11 +++++-- src/core/model/val-array.h | 5 +++ src/core/model/warnings.h | 13 ++++++-- .../event-garbage-collector-test-suite.cc | 2 +- src/core/test/examples-as-tests-test-suite.cc | 5 +-- ...variables-one-get-value-call-test-suite.cc | 11 +++---- src/core/test/matrix-array-test-suite.cc | 8 +++-- ...ariable-many-get-value-calls-test-suite.cc | 11 +++---- src/core/test/val-array-test-suite.cc | 15 +++++++++ src/dsdv/examples/dsdv-manet.cc | 6 +++- .../helper/dpdk-net-device-helper.h | 3 +- .../examples/traceroute-example.cc | 2 -- src/internet/helper/neighbor-cache-helper.h | 2 +- .../test/tcp-advertised-window-test.cc | 18 +++++----- src/internet/test/tcp-rate-ops-test.cc | 6 ++-- src/internet/test/tcp-rx-buffer-test.cc | 2 +- src/internet/test/tcp-tx-buffer-test.cc | 2 +- src/lr-wpan/model/lr-wpan-constants.h | 2 +- src/lte/model/ff-mac-common.h | 12 ++++--- src/propagation/model/jakes-process.h | 7 ++-- src/test/ns3tcp/ns3tcp-cubic-test-suite.cc | 8 ++--- src/uan/examples/uan-6lowpan-example.cc | 1 + src/uan/examples/uan-ipv4-example.cc | 1 + src/uan/examples/uan-ipv6-example.cc | 1 + src/uan/examples/uan-raw-example.cc | 1 + src/uan/examples/uan-rc-example.cc | 3 +- src/wifi/test/80211b.c | 28 ++++++++-------- src/wifi/test/wifi-mac-ofdma-test.cc | 1 - utils/print-introspected-doxygen.cc | 18 +++++----- 63 files changed, 257 insertions(+), 129 deletions(-) diff --git a/src/aodv/examples/aodv.cc b/src/aodv/examples/aodv.cc index 0d32222d4..79e2e378b 100644 --- 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 diff --git a/src/buildings/helper/building-container.h b/src/buildings/helper/building-container.h index 0f2f6fbd2..51faceecd 100644 --- 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 diff --git a/src/buildings/helper/building-position-allocator.h b/src/buildings/helper/building-position-allocator.h index 35d861f08..9a64703c1 100644 --- 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. */ diff --git a/src/buildings/helper/buildings-helper.h b/src/buildings/helper/buildings-helper.h index 1a557ba86..25e00766e 100644 --- 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 diff --git a/src/buildings/model/building-list.h b/src/buildings/model/building-list.h index c2286b065..55591abc8 100644 --- 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 diff --git a/src/buildings/model/building.h b/src/buildings/model/building.h index 74b072763..eef5b635c 100644 --- 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 diff --git a/src/buildings/model/buildings-channel-condition-model.h b/src/buildings/model/buildings-channel-condition-model.h index 518c9a084..5b532325a 100644 --- 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 diff --git a/src/buildings/model/buildings-propagation-loss-model.h b/src/buildings/model/buildings-propagation-loss-model.h index 6ba3d9a74..6c2f4eafc 100644 --- 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 diff --git a/src/buildings/model/hybrid-buildings-propagation-loss-model.h b/src/buildings/model/hybrid-buildings-propagation-loss-model.h index edaf6e69a..99b202544 100644 --- 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 diff --git a/src/buildings/model/itu-r-1238-propagation-loss-model.h b/src/buildings/model/itu-r-1238-propagation-loss-model.h index b6ded5bb9..017a362e7 100644 --- 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. * */ diff --git a/src/buildings/model/mobility-building-info.h b/src/buildings/model/mobility-building-info.h index ab9489b8b..49a9a93a6 100644 --- 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 diff --git a/src/buildings/model/oh-buildings-propagation-loss-model.h b/src/buildings/model/oh-buildings-propagation-loss-model.h index a7dd895bc..8b2a30116 100644 --- 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 diff --git a/src/buildings/model/random-walk-2d-outdoor-mobility-model.h b/src/buildings/model/random-walk-2d-outdoor-mobility-model.h index 1da68f8e6..d570b592f 100644 --- 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, diff --git a/src/buildings/model/three-gpp-v2v-channel-condition-model.h b/src/buildings/model/three-gpp-v2v-channel-condition-model.h index 0d50c409f..d5023da69 100644 --- 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 * diff --git a/src/buildings/test/building-position-allocator-test.cc b/src/buildings/test/building-position-allocator-test.cc index 980a921a7..8b186b4ef 100644 --- 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 */ diff --git a/src/buildings/test/buildings-channel-condition-model-test.cc b/src/buildings/test/buildings-channel-condition-model-test.cc index 15024a886..0e8604fa4 100644 --- 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 diff --git a/src/buildings/test/buildings-helper-test.cc b/src/buildings/test/buildings-helper-test.cc index 16489f85b..3a5f91d8a 100644 --- 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 */ diff --git a/src/buildings/test/buildings-pathloss-test.h b/src/buildings/test/buildings-pathloss-test.h index 7700d0c16..39c75ca61 100644 --- 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 * diff --git a/src/buildings/test/buildings-shadowing-test.h b/src/buildings/test/buildings-shadowing-test.h index 68a2af7f5..bd8091b8a 100644 --- 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 */ diff --git a/src/buildings/test/outdoor-random-walk-test.cc b/src/buildings/test/outdoor-random-walk-test.cc index ebb3f3240..7f3c9433c 100644 --- 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 */ diff --git a/src/buildings/test/three-gpp-v2v-channel-condition-model-test.cc b/src/buildings/test/three-gpp-v2v-channel-condition-model-test.cc index bd3e041c5..ad4240755 100644 --- 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 * diff --git a/src/click/test/ipv4-click-routing-test.cc b/src/click/test/ipv4-click-routing-test.cc index 93c915af3..bd9fb6095 100644 --- 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) } /** + * \ingroup click-tests * Add network device. * * \param node Node. diff --git a/src/config-store/examples/config-store-save.cc b/src/config-store/examples/config-store-save.cc index b72c615c9..65ef5791b 100644 --- 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 */ diff --git a/src/core/examples/empirical-random-variable-example.cc b/src/core/examples/empirical-random-variable-example.cc index ce78a348d..a44ee9551 100644 --- a/src/core/examples/empirical-random-variable-example.cc +++ b/src/core/examples/empirical-random-variable-example.cc @@ -29,9 +29,13 @@ #include /** - * \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 * diff --git a/src/core/helper/csv-reader.cc b/src/core/helper/csv-reader.cc index 0bb534294..c62e30b27 100644 --- 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 diff --git a/src/core/helper/csv-reader.h b/src/core/helper/csv-reader.h index bb8ecef74..49c9e9f8b 100644 --- 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 diff --git a/src/core/model/attribute-container.h b/src/core/model/attribute-container.h index 547d6fa28..ef74545db 100644 --- 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 MakeAttributeContainerChecker( const AttributeContainerValue& 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 C = std::list> Ptr MakeAttributeContainerChecker(Ptr 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 C = std::list> Ptr 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 class C = std::list Ptr 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. diff --git a/src/core/model/config.cc b/src/core/model/config.cc index 5f6c51aa8..578d4c7be 100644 --- 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 { diff --git a/src/core/model/deprecated.h b/src/core/model/deprecated.h index 2e9069aed..84b1eb644 100644 --- 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. */ diff --git a/src/core/model/global-value.h b/src/core/model/global-value.h index d1e1327d1..179191c01 100644 --- 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'. * diff --git a/src/core/model/nstime.h b/src/core/model/nstime.h index 85cb00259..a90ebd295 100644 --- 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 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. diff --git a/src/core/model/object-ptr-container.h b/src/core/model/object-ptr-container.h index 931ad9f32..b77cfc339 100644 --- 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 Ptr MakeObjectPtrContainerAccessor(INDEX (T::*getN)() const, Ptr (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 Ptr 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 class ObjectPtrContainerChecker : public ns3::ObjectPtrContainerChecker { diff --git a/src/core/model/scheduler.h b/src/core/model/scheduler.h index f69ba333b..096102e8c 100644 --- 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: diff --git a/src/core/model/simulation-singleton.h b/src/core/model/simulation-singleton.h index 9f18b79e6..b4ea33c17 100644 --- 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 diff --git a/src/core/model/singleton.h b/src/core/model/singleton.h index a50e604ec..9ee0361f0 100644 --- 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. diff --git a/src/core/model/val-array.h b/src/core/model/val-array.h index 9bd2ad968..d90050be3 100644 --- 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 * diff --git a/src/core/model/warnings.h b/src/core/model/warnings.h index 5e38d0134..58bb02994 100644 --- 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. * diff --git a/src/core/test/event-garbage-collector-test-suite.cc b/src/core/test/event-garbage-collector-test-suite.cc index 9ee43a570..b0602d341 100644 --- 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. */ diff --git a/src/core/test/examples-as-tests-test-suite.cc b/src/core/test/examples-as-tests-test-suite.cc index 8a7c67815..409ead806 100644 --- 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 diff --git 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 index 583c98eba..3afe7b4e8 100644 --- 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 diff --git a/src/core/test/matrix-array-test-suite.cc b/src/core/test/matrix-array-test-suite.cc index 574fe4dd7..044106675 100644 --- 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 */ diff --git 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 index 18f24b978..6d5edb7fc 100644 --- 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 diff --git a/src/core/test/val-array-test-suite.cc b/src/core/test/val-array-test-suite.cc index 4c06e34cd..609217302 100644 --- 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 diff --git a/src/dsdv/examples/dsdv-manet.cc b/src/dsdv/examples/dsdv-manet.cc index 63b6bcca5..0606322c9 100644 --- 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 */ diff --git a/src/fd-net-device/helper/dpdk-net-device-helper.h b/src/fd-net-device/helper/dpdk-net-device-helper.h index d0cb0bdb5..b155327fd 100644 --- 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 { diff --git a/src/internet-apps/examples/traceroute-example.cc b/src/internet-apps/examples/traceroute-example.cc index 88e62473a..e321bf169 100644 --- 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" diff --git a/src/internet/helper/neighbor-cache-helper.h b/src/internet/helper/neighbor-cache-helper.h index c52418ec2..53b5cee59 100644 --- 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. * diff --git a/src/internet/test/tcp-advertised-window-test.cc b/src/internet/test/tcp-advertised-window-test.cc index 3a47e5ded..a3bf259e4 100644 --- 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 */ diff --git a/src/internet/test/tcp-rate-ops-test.cc b/src/internet/test/tcp-rate-ops-test.cc index 5ab857265..d645b4bc7 100644 --- 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 diff --git a/src/internet/test/tcp-rx-buffer-test.cc b/src/internet/test/tcp-rx-buffer-test.cc index 5ba345ca2..bfc683283 100644 --- 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 diff --git a/src/internet/test/tcp-tx-buffer-test.cc b/src/internet/test/tcp-tx-buffer-test.cc index 24ac62f15..275276e53 100644 --- 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 diff --git a/src/lr-wpan/model/lr-wpan-constants.h b/src/lr-wpan/model/lr-wpan-constants.h index 609b5dc35..29898622d 100644 --- 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. diff --git a/src/lte/model/ff-mac-common.h b/src/lte/model/ff-mac-common.h index 66c54e33e..e2c00c8cf 100644 --- 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 }; diff --git a/src/propagation/model/jakes-process.h b/src/propagation/model/jakes-process.h index f9040e675..9d0ccd5ea 100644 --- 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 diff --git a/src/test/ns3tcp/ns3tcp-cubic-test-suite.cc b/src/test/ns3tcp/ns3tcp-cubic-test-suite.cc index 66310c88d..a05a789d4 100644 --- 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; diff --git a/src/uan/examples/uan-6lowpan-example.cc b/src/uan/examples/uan-6lowpan-example.cc index 4644cc0fb..f1f83c807 100644 --- 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) diff --git a/src/uan/examples/uan-ipv4-example.cc b/src/uan/examples/uan-ipv4-example.cc index b1343bc14..9f2fcafec 100644 --- 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) diff --git a/src/uan/examples/uan-ipv6-example.cc b/src/uan/examples/uan-ipv6-example.cc index ed44d93ff..b35ad3ca2 100644 --- 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) diff --git a/src/uan/examples/uan-raw-example.cc b/src/uan/examples/uan-raw-example.cc index ee58b382c..82ae59c42 100644 --- 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) diff --git a/src/uan/examples/uan-rc-example.cc b/src/uan/examples/uan-rc-example.cc index fb677c48c..b894e6250 100644 --- 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 diff --git a/src/wifi/test/80211b.c b/src/wifi/test/80211b.c index b86cc3c8a..3a6ec6b84 100644 --- a/src/wifi/test/80211b.c +++ b/src/wifi/test/80211b.c @@ -17,9 +17,13 @@ * Author: Gary Pei */ -/* +/** + * \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 #include #include @@ -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 */ diff --git a/src/wifi/test/wifi-mac-ofdma-test.cc b/src/wifi/test/wifi-mac-ofdma-test.cc index 9c9748f49..70e2db481 100644 --- 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 diff --git a/utils/print-introspected-doxygen.cc b/utils/print-introspected-doxygen.cc index 1ddcb2a0d..aae99921f 100644 --- 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 () /***************************************************************