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 |