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

Unified Diff: src/core/test/object-test-suite.cc

Issue 318360043: Final updates to correct doxygen warnings for the core module (Closed)
Patch Set: Additional doxygen corrections 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/core/test/object-test-suite.cc
===================================================================
--- a/src/core/test/object-test-suite.cc
+++ b/src/core/test/object-test-suite.cc
@@ -25,6 +25,12 @@
namespace {
+/**
+ * \ingroup core-test
+ * \ingroup tests
+ *
+ * \brief Base class A.
+ */
class BaseA : public ns3::Object
{
public:
@@ -43,9 +49,16 @@
}
BaseA ()
{}
+ /// Dispose function
virtual void Dispose (void) {}
};
+/**
+ * \ingroup core-test
+ * \ingroup tests
+ *
+ * \brief Derived class A.
+ */
class DerivedA : public BaseA
{
public:
@@ -64,11 +77,18 @@
}
DerivedA ()
{}
+ /// Dispose function
virtual void Dispose (void) {
BaseA::Dispose ();
}
};
+/**
+ * \ingroup core-test
+ * \ingroup tests
+ *
+ * \brief Base class B.
+ */
class BaseB : public ns3::Object
{
public:
@@ -87,9 +107,16 @@
}
BaseB ()
{}
+ /// Dispose function
virtual void Dispose (void) {}
};
+/**
+ * \ingroup core-test
+ * \ingroup tests
+ *
+ * \brief Derived class B.
+ */
class DerivedB : public BaseB
{
public:
@@ -108,6 +135,7 @@
}
DerivedB ()
{}
+ /// Dispose function
virtual void Dispose (void) {
BaseB::Dispose ();
}
@@ -122,9 +150,12 @@
using namespace ns3;
-// ===========================================================================
-// Test case to make sure that we can make Objects using CreateObject.
-// ===========================================================================
+/**
+ * \ingroup core-test
+ * \ingroup tests
+ *
+ * \brief Test case to make sure that we can make Objects using CreateObject.
+ */
class CreateObjectTestCase : public TestCase
{
public:
@@ -188,9 +219,12 @@
NS_TEST_ASSERT_MSG_EQ (baseA->GetObject<BaseA> (DerivedA::GetTypeId ()), baseA, "GetObject returns different Ptr");
}
-// ===========================================================================
-// Test case to make sure that we can aggregate Objects.
-// ===========================================================================
+/**
+ * \ingroup core-test
+ * \ingroup tests
+ *
+ * \brief Test case to make sure that we can aggregate Objects.
+ */
class AggregateObjectTestCase : public TestCase
{
public:
@@ -359,9 +393,12 @@
NS_TEST_ASSERT_MSG_NE (baseA, 0, "Unable to GetObject on released object");
}
-// ===========================================================================
-// Test case to make sure that an Object factory can create Objects
-// ===========================================================================
+/**
+ * \ingroup core-test
+ * \ingroup tests
+ *
+ * \brief Test case to make sure that an Object factory can create Objects
+ */
class ObjectFactoryTestCase : public TestCase
{
public:
@@ -431,9 +468,12 @@
NS_TEST_ASSERT_MSG_NE (a->GetObject<DerivedA> (), 0, "Unexpectedly able to work around C++ type system");
}
-// ===========================================================================
-// The Test Suite that glues the Test Cases together.
-// ===========================================================================
+/**
+ * \ingroup core-test
+ * \ingroup tests
+ *
+ * \brief The Test Suite that glues the Test Cases together.
+ */
class ObjectTestSuite : public TestSuite
{
public:
« no previous file with comments | « src/core/test/names-test-suite.cc ('k') | src/core/test/one-uniform-random-variable-many-get-value-calls-test-suite.cc » ('j') | no next file with comments »

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