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

Unified Diff: src/lte/test/lte-test-link-adaptation.h

Issue 315450043: LTE module corrections for doxygen warnings (Closed)
Patch Set: Created 7 years, 2 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/lte/test/lte-test-interference-fr.h ('k') | src/lte/test/lte-test-mimo.h » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: src/lte/test/lte-test-link-adaptation.h
===================================================================
--- a/src/lte/test/lte-test-link-adaptation.h
+++ b/src/lte/test/lte-test-link-adaptation.h
@@ -28,7 +28,10 @@
/**
- * Test 1.3 Link adaptation
+ * \ingroup lte-test
+ * \ingroup tests
+ *
+ * \brief Test 1.3 Link adaptation
*/
class LteLinkAdaptationTestSuite : public TestSuite
{
@@ -37,21 +40,39 @@
};
+/**
+ * \ingroup lte-test
+ * \ingroup tests
+ *
+ * \brief Lte Link Adaptation Test Case
+ */
class LteLinkAdaptationTestCase : public TestCase
{
public:
+ /**
+ * Constructor
+ *
+ * \param name the reference name
+ * \param snrDb the SNR in dB
+ * \param loss the loss
+ * \param mcsIndex the DL se
+ */
LteLinkAdaptationTestCase (std::string name, double snrDb, double loss, uint16_t mcsIndex);
LteLinkAdaptationTestCase ();
virtual ~LteLinkAdaptationTestCase ();
+ /**
+ * \brief DL scheduling function
+ * \param dlInfo the DL info
+ */
void DlScheduling (DlSchedulingCallbackInfo dlInfo);
private:
virtual void DoRun (void);
- double m_snrDb;
- double m_loss;
- uint16_t m_mcsIndex;
+ double m_snrDb; ///< the SNR in dB
+ double m_loss; ///< the loss
+ uint16_t m_mcsIndex; ///< the MCS index
};
#endif /* LTE_TEST_LINK_ADAPTATION_H */
« no previous file with comments | « src/lte/test/lte-test-interference-fr.h ('k') | src/lte/test/lte-test-mimo.h » ('j') | no next file with comments »

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