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

Unified Diff: src/spectrum/test/spectrum-value-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
Index: src/spectrum/test/spectrum-value-test.cc
===================================================================
--- a/src/spectrum/test/spectrum-value-test.cc
+++ b/src/spectrum/test/spectrum-value-test.cc
@@ -34,17 +34,36 @@
#define TOLERANCE 1e-6
+/**
+ * \ingroup spectrum-test
+ * \ingroup tests
+ *
+ * \brief Spectrum Value Test Case
+ */
class SpectrumValueTestCase : public TestCase
{
public:
+ /**
+ * Constructor
+ *
+ * \param a spectrum a
+ * \param b spectrum b
+ * \param name reference name
+ */
SpectrumValueTestCase (SpectrumValue a, SpectrumValue b, std::string name);
virtual ~SpectrumValueTestCase ();
virtual void DoRun (void);
private:
+ /**
+ * More or less equal function
+ * \param x the first spectrum value
+ * \param y the second spectrum value
+ * \returns true if "equal"
+ */
bool MoreOrLessEqual (SpectrumValue x, SpectrumValue y);
- SpectrumValue m_a;
- SpectrumValue m_b;
+ SpectrumValue m_a; ///< a value
+ SpectrumValue m_b; ///< b value
};
@@ -81,7 +100,12 @@
-
+/**
+ * \ingroup spectrum-test
+ * \ingroup tests
+ *
+ * \brief Spectrum Value Test Suite
+ */
class SpectrumValueTestSuite : public TestSuite
{
public:
@@ -249,7 +273,12 @@
-
+/**
+ * \ingroup spectrum-test
+ * \ingroup tests
+ *
+ * \brief Spectrum Converter Test Suite
+ */
class SpectrumConverterTestSuite : public TestSuite
{
public:
« no previous file with comments | « src/spectrum/test/spectrum-interference-test.cc ('k') | src/spectrum/test/spectrum-waveform-generator-test.cc » ('j') | no next file with comments »

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