]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[#3245] Remove wrong doxygen use in UT
authorThomas Markwalder <tmark@isc.org>
Wed, 21 Feb 2024 16:46:35 +0000 (11:46 -0500)
committerThomas Markwalder <tmark@isc.org>
Fri, 23 Feb 2024 12:08:04 +0000 (12:08 +0000)
modified:   alarm_unittests.cc
modified:   monitored_duration_unittests.cc

src/hooks/dhcp/perfmon/tests/alarm_unittests.cc
src/hooks/dhcp/perfmon/tests/monitored_duration_unittests.cc

index 3e121cf4ba66845ef48f56ab098eb8a8310c2f7b..759b3bdc7330e4c28e6e23533dc5f9cae347073f 100644 (file)
@@ -20,7 +20,7 @@ using namespace boost::posix_time;
 
 namespace {
 
-/// @brief Verifies Alarm construction.
+// Verifies Alarm construction.
 TEST(Alarm, validConstructors) {
     AlarmPtr alarm;
 
@@ -69,7 +69,7 @@ TEST(Alarm, validConstructors) {
     EXPECT_GE(alarm->getStosTime(), start_time);
 }
 
-/// @brief Verifies Alarm invalid construction.
+// Verifies Alarm invalid construction.
 TEST(Alarm, invalidConstructors) {
     AlarmPtr alarm;
 
@@ -168,40 +168,40 @@ TEST(Alarm, clearAndDisable) {
     EXPECT_EQ(alarm->getLastHighWaterReport(), PktEvent::EMPTY_TIME());
 }
 
-/// @brief Verifies the result of Alarm::checkSample() over the range of scenarios.
-/// The alarm is created in either the CLEAR or TRIGGERED state and then checkSample()
-/// is invoked.  The scenarios tested are described by the table below:
-///
-/// ```
-///                     INPUT                           |          OUTPUT
-///    Test sample relationship       Input  Report Int.|
+// Verifies the result of Alarm::checkSample() over the range of scenarios.
+// The alarm is created in either the CLEAR or TRIGGERED state and then checkSample()
+// is invoked.  The scenarios tested are described by the table below:
+//
+// ```
+//                     INPUT                           |          OUTPUT
+//    Test sample relationship       Input  Report Int.|
 //     to the thresholds              State   Elapsed   | Report  State  Stos   Last Report
-///    -------------------------------------------------|----------------------------------
-///    sample < low_water                C      false   | false     C      -       -
-///    sample < low_water                C      true    | false     C      -       -
-///    sample < low_water                T      false   | true      C    updated  reset
-///    sample < low_water                T      true    | true      C    updated  reset
-///                                                     |
-///    sample == low_water               C      false   | false     C      -       -
-///    sample == low_water               C      true    | false     C      -       -
-///    sample == low_water               T      false   | false     T      -       -
-///    sample == low_water               T      true    | true      T             updated
-///                                                     |
-///    low_water < sample < high_water   C      false   | false     C      -       -
-///    low_water < sample < high_water   C      true    | false     C      -       -
-///    low_water < sample < high_water   T      false   | false     T      -       -
-///    low_water < sample < high_water   T      true    | true      T      -      updated
-///                                                     |
-///    sample == high water              C      false   | false     C      -       -
-///    sample == high water              C      true    | false     C      -       -
-///    sample == high water              T      false   | false     T      -       -
-///    sample == high water              T      true    | true      T      -      updated
-///                                                     |
-///    sample > high water               C      false   | true      T    updated  set
-///    sample > high water               C      true    | true      T    updated  set
-///    sample > high water               T      false   | false     T      -       -
-///    sample > high water               T      true    | true      T      -      updated
-/// ```
+//    -------------------------------------------------|----------------------------------
+//    sample < low_water                C      false   | false     C      -       -
+//    sample < low_water                C      true    | false     C      -       -
+//    sample < low_water                T      false   | true      C    updated  reset
+//    sample < low_water                T      true    | true      C    updated  reset
+//                                                     |
+//    sample == low_water               C      false   | false     C      -       -
+//    sample == low_water               C      true    | false     C      -       -
+//    sample == low_water               T      false   | false     T      -       -
+//    sample == low_water               T      true    | true      T             updated
+//                                                     |
+//    low_water < sample < high_water   C      false   | false     C      -       -
+//    low_water < sample < high_water   C      true    | false     C      -       -
+//    low_water < sample < high_water   T      false   | false     T      -       -
+//    low_water < sample < high_water   T      true    | true      T      -      updated
+//                                                     |
+//    sample == high water              C      false   | false     C      -       -
+//    sample == high water              C      true    | false     C      -       -
+//    sample == high water              T      false   | false     T      -       -
+//    sample == high water              T      true    | true      T      -      updated
+//                                                     |
+//    sample > high water               C      false   | true      T    updated  set
+//    sample > high water               C      true    | true      T    updated  set
+//    sample > high water               T      false   | false     T      -       -
+//    sample > high water               T      true    | true      T      -      updated
+// ```
 TEST(Alarm, checkSample) {
     // Create mnemonic constants.
     Duration low_water(milliseconds(100));
index 5b788e5ffc28fa1e9a5340af5a244b0f1929299b..cce92f068d107c2096e32f6fb6238a5b6457544b 100644 (file)
@@ -20,7 +20,7 @@ using namespace boost::posix_time;
 
 namespace {
 
-/// @brief Exercises the basic functions of DurationDataInterval.
+// Exercises the basic functions of DurationDataInterval.
 TEST(DurationDataInterval, basics) {
     auto start_time = PktEvent::now();
 
@@ -80,7 +80,7 @@ TEST(DurationDataInterval, basics) {
     EXPECT_EQ(interval->getAverageDuration(), Duration(microseconds(112500)));
 }
 
-/// @brief Exercises the basic functions of DurationDataInterval.
+// Exercises the basic functions of DurationDataInterval.
 TEST(DurationKey, basics) {
     DurationKeyPtr key;
 
@@ -115,7 +115,7 @@ TEST(DurationKey, basics) {
                      "Query type not supported by monitoring: ADVERTISE");
 }
 
-/// @brief Verify v4 message pair validation works.
+// Verify v4 message pair validation works.
 TEST(DurationKey, validateMessagePairs4) {
     //  Defines a test scenario.
     struct Scenario {
@@ -165,7 +165,7 @@ TEST(DurationKey, validateMessagePairs4) {
     }
 }
 
-/// @brief Verify v4 message pair validation works.
+// Verify v4 message pair validation works.
 TEST(DurationKey, validateMessagePairs6) {
     //  Defines a test scenario.
     struct Scenario {
@@ -232,7 +232,7 @@ TEST(DurationKey, validateMessagePairs6) {
     }
 }
 
-/// @brief Verifies MonitoredDuration valid construction.
+// Verifies MonitoredDuration valid construction.
 TEST(MonitoredDuration, validConstructors) {
     MonitoredDurationPtr mond;
     Duration interval_duration(seconds(60));
@@ -272,7 +272,7 @@ TEST(MonitoredDuration, validConstructors) {
     EXPECT_FALSE(mond->getPreviousInterval());
 }
 
-/// @brief Verifies MonitoredDuration invalid construction.
+// Verifies MonitoredDuration invalid construction.
 TEST(MonitoredDuration, invalidConstructors) {
     MonitoredDurationPtr mond;