diff options
Diffstat (limited to 'include/cppunit/extensions')
| -rw-r--r-- | include/cppunit/extensions/TestFactory.h | 4 | ||||
| -rw-r--r-- | include/cppunit/extensions/TestFactoryRegistry.h | 4 | ||||
| -rw-r--r-- | include/cppunit/extensions/TestSuiteBuilder.h | 7 | ||||
| -rw-r--r-- | include/cppunit/extensions/TestSuiteFactory.h | 3 |
4 files changed, 14 insertions, 4 deletions
diff --git a/include/cppunit/extensions/TestFactory.h b/include/cppunit/extensions/TestFactory.h index 3b1f001..3a964b6 100644 --- a/include/cppunit/extensions/TestFactory.h +++ b/include/cppunit/extensions/TestFactory.h @@ -7,14 +7,14 @@ namespace CppUnit { class Test; -/** This class represents an abstract Test factory. +/*! \brief Abstract Test factory. */ class CPPUNIT_API TestFactory { public: virtual ~TestFactory() {} - /** Makes a new test. + /*! Makes a new test. * \return A new Test. */ virtual Test* makeTest() = 0; diff --git a/include/cppunit/extensions/TestFactoryRegistry.h b/include/cppunit/extensions/TestFactoryRegistry.h index 1484977..3d715a1 100644 --- a/include/cppunit/extensions/TestFactoryRegistry.h +++ b/include/cppunit/extensions/TestFactoryRegistry.h @@ -21,9 +21,9 @@ class TestSuite; #endif -/** This class implements a registry for test factory. +/*! \brief Registry for test factory. * - * Note that the registry assume lifetime control for any registered test. + * Notes that the registry assumes lifetime control for any registered test. */ class CPPUNIT_API TestFactoryRegistry : public TestFactory { diff --git a/include/cppunit/extensions/TestSuiteBuilder.h b/include/cppunit/extensions/TestSuiteBuilder.h index bcddfee..44ad3fc 100644 --- a/include/cppunit/extensions/TestSuiteBuilder.h +++ b/include/cppunit/extensions/TestSuiteBuilder.h @@ -12,6 +12,13 @@ namespace CppUnit { + /*! \brief Helper to add test to a TestSuite. + * + * All test added to the TestSuite are prefixed by TestSuite name. The resulting + * Test name has the following pattern: + * + * MyTestSuiteName.myTestName + */ template<typename Fixture> class TestSuiteBuilder { diff --git a/include/cppunit/extensions/TestSuiteFactory.h b/include/cppunit/extensions/TestSuiteFactory.h index cc07471..567812d 100644 --- a/include/cppunit/extensions/TestSuiteFactory.h +++ b/include/cppunit/extensions/TestSuiteFactory.h @@ -7,6 +7,9 @@ namespace CppUnit { class Test; + /*! \brief TestFactory for TestFixture that implements a static suite() method. + * \see AutoRegisterSuite. + */ template<typename TestCaseType> class TestSuiteFactory : public TestFactory { |
