Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code | Sign in
(914)

Unified Diff: src/spectrum/test/spectrum-interference-test.cc

Issue 320100043: Final updates to correct doxygen warnigns for the spectrum model (Closed)
Patch Set: Additional doxygen changes Created 6 years, 10 months ago
Use n/p to move between diff chunks; N/P to move between comments. Please Sign in to add in-line comments.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « src/spectrum/test/spectrum-ideal-phy-test.cc ('k') | src/spectrum/test/spectrum-value-test.cc » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: src/spectrum/test/spectrum-interference-test.cc
===================================================================
--- a/src/spectrum/test/spectrum-interference-test.cc
+++ b/src/spectrum/test/spectrum-interference-test.cc
@@ -33,20 +33,37 @@
NS_LOG_COMPONENT_DEFINE ("SpectrumInterferenceTest");
-
+/**
+ * \ingroup spectrum-test
+ * \ingroup tests
+ *
+ * \brief Spectrum Interference Test Case
+ */
class SpectrumInterferenceTestCase : public TestCase
{
public:
+ /**
+ * Constructor
+ *
+ * \param s spectrum
+ * \param txBytes transmit bytes
+ * \param rxCorrect receive correction?
+ * \param name reference name
+ */
SpectrumInterferenceTestCase (Ptr<SpectrumValue> s, uint32_t txBytes, bool rxCorrect, std::string name);
virtual ~SpectrumInterferenceTestCase ();
virtual void DoRun (void);
+ /**
+ * Retrieve test result function
+ * \param si the spectrum interference
+ */
void RetrieveTestResult (SpectrumInterference* si);
private:
- Ptr<SpectrumValue> m_s;
- uint32_t m_txBytes;
- uint32_t m_rxCorrectKnownOutcome;
- Ptr<const SpectrumModel> m_mySpectrumModel;
+ Ptr<SpectrumValue> m_s; ///< spectrum value
+ uint32_t m_txBytes; ///< transmit bytes
+ uint32_t m_rxCorrectKnownOutcome; ///< receive correct known outcome
+ Ptr<const SpectrumModel> m_mySpectrumModel; ///< spectrum model
};
@@ -129,7 +146,12 @@
}
-
+/**
+ * \ingroup spectrum-test
+ * \ingroup tests
+ *
+ * \brief Spectrum Interference Test Suite
+ */
class SpectrumInterferenceTestSuite : public TestSuite
{
public:
@@ -191,4 +213,4 @@
}
-static SpectrumInterferenceTestSuite spectrumInterferenceTestSuite;
+static SpectrumInterferenceTestSuite spectrumInterferenceTestSuite; ///< the test suite
« no previous file with comments | « src/spectrum/test/spectrum-ideal-phy-test.cc ('k') | src/spectrum/test/spectrum-value-test.cc » ('j') | no next file with comments »

Powered by Google App Engine
RSS Feeds Recent Issues | This issue
This is Rietveld f62528b