Index: src/spectrum/test/tv-spectrum-transmitter-test.cc |
=================================================================== |
--- a/src/spectrum/test/tv-spectrum-transmitter-test.cc |
+++ b/src/spectrum/test/tv-spectrum-transmitter-test.cc |
@@ -41,9 +41,23 @@ |
// Follows http://realtimecollisiondetection.net/blog/?p=89 |
double epsilon; |
+/** |
+ * \ingroup spectrum-test |
+ * \ingroup tests |
+ * |
+ * \brief Tv Spectrum Transmitter Test Case |
+ */ |
class TvSpectrumTransmitterTestCase : public TestCase |
{ |
public: |
+ /** |
+ * Constructor |
+ * |
+ * \param startFrequency starting frequency |
+ * \param channelBandwidth channel bandwidth |
+ * \param basePsd base PSD |
+ * \param tvType transmitter type |
+ */ |
TvSpectrumTransmitterTestCase (double startFrequency, |
double channelBandwidth, |
double basePsd, |
@@ -52,15 +66,23 @@ |
private: |
virtual void DoRun (void); |
+ /** |
+ * Name function |
+ * \param tvType the TV type |
+ * \param startFrequency the start frequency |
+ * \param channelBandwidth the channel bandwidth |
+ * \param basePsd the base PSD |
+ * \returns the name string |
+ */ |
static std::string Name (TvSpectrumTransmitter::TvType tvType, |
double startFrequency, |
double channelBandwidth, |
double basePsd); |
- double m_startFrequency; |
- double m_channelBandwidth; |
- double m_basePsd; |
- TvSpectrumTransmitter::TvType m_tvType; |
+ double m_startFrequency; ///< start frequency |
+ double m_channelBandwidth; ///< channel bandwidth |
+ double m_basePsd; ///< based PSD |
+ TvSpectrumTransmitter::TvType m_tvType; ///< tv type |
}; |
@@ -153,7 +175,12 @@ |
"end frequency value (" << (*(bandEnd - 1)).fc << ") is incorrect"); |
} |
- |
+/** |
+ * \ingroup spectrum-test |
+ * \ingroup tests |
+ * |
+ * \brief Tv Spectrum Transmitter Test Suite |
+ */ |
class TvSpectrumTransmitterTestSuite : public TestSuite |
{ |
public: |
@@ -208,4 +235,4 @@ |
} |
} |
-static TvSpectrumTransmitterTestSuite g_tvSpectrumTransmitterTestSuite; |
+static TvSpectrumTransmitterTestSuite g_tvSpectrumTransmitterTestSuite; ///< the test suite |