Skip to content

Commit 88bbd44

Browse files
committed
[#3245] Remove wrong doxygen use in UT
modified: alarm_unittests.cc modified: monitored_duration_unittests.cc
1 parent 5633edb commit 88bbd44

File tree

2 files changed

+41
-41
lines changed

2 files changed

+41
-41
lines changed

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

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ using namespace boost::posix_time;
2020

2121
namespace {
2222

23-
/// @brief Verifies Alarm construction.
23+
// Verifies Alarm construction.
2424
TEST(Alarm, validConstructors) {
2525
AlarmPtr alarm;
2626

@@ -69,7 +69,7 @@ TEST(Alarm, validConstructors) {
6969
EXPECT_GE(alarm->getStosTime(), start_time);
7070
}
7171

72-
/// @brief Verifies Alarm invalid construction.
72+
// Verifies Alarm invalid construction.
7373
TEST(Alarm, invalidConstructors) {
7474
AlarmPtr alarm;
7575

@@ -168,40 +168,40 @@ TEST(Alarm, clearAndDisable) {
168168
EXPECT_EQ(alarm->getLastHighWaterReport(), PktEvent::EMPTY_TIME());
169169
}
170170

171-
/// @brief Verifies the result of Alarm::checkSample() over the range of scenarios.
172-
/// The alarm is created in either the CLEAR or TRIGGERED state and then checkSample()
173-
/// is invoked. The scenarios tested are described by the table below:
174-
///
175-
/// ```
176-
/// INPUT | OUTPUT
177-
/// Test sample relationship Input Report Int.|
171+
// Verifies the result of Alarm::checkSample() over the range of scenarios.
172+
// The alarm is created in either the CLEAR or TRIGGERED state and then checkSample()
173+
// is invoked. The scenarios tested are described by the table below:
174+
//
175+
// ```
176+
// INPUT | OUTPUT
177+
// Test sample relationship Input Report Int.|
178178
// to the thresholds State Elapsed | Report State Stos Last Report
179-
/// -------------------------------------------------|----------------------------------
180-
/// sample < low_water C false | false C - -
181-
/// sample < low_water C true | false C - -
182-
/// sample < low_water T false | true C updated reset
183-
/// sample < low_water T true | true C updated reset
184-
/// |
185-
/// sample == low_water C false | false C - -
186-
/// sample == low_water C true | false C - -
187-
/// sample == low_water T false | false T - -
188-
/// sample == low_water T true | true T updated
189-
/// |
190-
/// low_water < sample < high_water C false | false C - -
191-
/// low_water < sample < high_water C true | false C - -
192-
/// low_water < sample < high_water T false | false T - -
193-
/// low_water < sample < high_water T true | true T - updated
194-
/// |
195-
/// sample == high water C false | false C - -
196-
/// sample == high water C true | false C - -
197-
/// sample == high water T false | false T - -
198-
/// sample == high water T true | true T - updated
199-
/// |
200-
/// sample > high water C false | true T updated set
201-
/// sample > high water C true | true T updated set
202-
/// sample > high water T false | false T - -
203-
/// sample > high water T true | true T - updated
204-
/// ```
179+
// -------------------------------------------------|----------------------------------
180+
// sample < low_water C false | false C - -
181+
// sample < low_water C true | false C - -
182+
// sample < low_water T false | true C updated reset
183+
// sample < low_water T true | true C updated reset
184+
// |
185+
// sample == low_water C false | false C - -
186+
// sample == low_water C true | false C - -
187+
// sample == low_water T false | false T - -
188+
// sample == low_water T true | true T updated
189+
// |
190+
// low_water < sample < high_water C false | false C - -
191+
// low_water < sample < high_water C true | false C - -
192+
// low_water < sample < high_water T false | false T - -
193+
// low_water < sample < high_water T true | true T - updated
194+
// |
195+
// sample == high water C false | false C - -
196+
// sample == high water C true | false C - -
197+
// sample == high water T false | false T - -
198+
// sample == high water T true | true T - updated
199+
// |
200+
// sample > high water C false | true T updated set
201+
// sample > high water C true | true T updated set
202+
// sample > high water T false | false T - -
203+
// sample > high water T true | true T - updated
204+
// ```
205205
TEST(Alarm, checkSample) {
206206
// Create mnemonic constants.
207207
Duration low_water(milliseconds(100));

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ using namespace boost::posix_time;
2020

2121
namespace {
2222

23-
/// @brief Exercises the basic functions of DurationDataInterval.
23+
// Exercises the basic functions of DurationDataInterval.
2424
TEST(DurationDataInterval, basics) {
2525
auto start_time = PktEvent::now();
2626

@@ -80,7 +80,7 @@ TEST(DurationDataInterval, basics) {
8080
EXPECT_EQ(interval->getAverageDuration(), Duration(microseconds(112500)));
8181
}
8282

83-
/// @brief Exercises the basic functions of DurationDataInterval.
83+
// Exercises the basic functions of DurationDataInterval.
8484
TEST(DurationKey, basics) {
8585
DurationKeyPtr key;
8686

@@ -115,7 +115,7 @@ TEST(DurationKey, basics) {
115115
"Query type not supported by monitoring: ADVERTISE");
116116
}
117117

118-
/// @brief Verify v4 message pair validation works.
118+
// Verify v4 message pair validation works.
119119
TEST(DurationKey, validateMessagePairs4) {
120120
// Defines a test scenario.
121121
struct Scenario {
@@ -165,7 +165,7 @@ TEST(DurationKey, validateMessagePairs4) {
165165
}
166166
}
167167

168-
/// @brief Verify v4 message pair validation works.
168+
// Verify v4 message pair validation works.
169169
TEST(DurationKey, validateMessagePairs6) {
170170
// Defines a test scenario.
171171
struct Scenario {
@@ -232,7 +232,7 @@ TEST(DurationKey, validateMessagePairs6) {
232232
}
233233
}
234234

235-
/// @brief Verifies MonitoredDuration valid construction.
235+
// Verifies MonitoredDuration valid construction.
236236
TEST(MonitoredDuration, validConstructors) {
237237
MonitoredDurationPtr mond;
238238
Duration interval_duration(seconds(60));
@@ -272,7 +272,7 @@ TEST(MonitoredDuration, validConstructors) {
272272
EXPECT_FALSE(mond->getPreviousInterval());
273273
}
274274

275-
/// @brief Verifies MonitoredDuration invalid construction.
275+
// Verifies MonitoredDuration invalid construction.
276276
TEST(MonitoredDuration, invalidConstructors) {
277277
MonitoredDurationPtr mond;
278278

0 commit comments

Comments
 (0)