diff options
| author | Baptiste Lepilleur <gaiacrtn@free.fr> | 2002-03-27 18:04:02 +0000 |
|---|---|---|
| committer | Baptiste Lepilleur <gaiacrtn@free.fr> | 2002-03-27 18:04:02 +0000 |
| commit | 1858c0b90eeee745b3d8f1e2c52d4614c4307ddc (patch) | |
| tree | 6c1c391304c63241a74f25cd8b7ad9b91d91faae /include/cppunit | |
| parent | 8f5672c150b457d3d4709256797692bdf0c6b920 (diff) | |
| download | cppunit-1858c0b90eeee745b3d8f1e2c52d4614c4307ddc.tar.gz | |
Include/msvc/testrunner/TestRunner.
include/msvc/testrunner/TestRunner.h: updated doc. reindented.
* include/cppunit/Asserter.h:
* include/cppunit/Asserter.cpp:
* include/cppunit/TestResultCollector.h:
* include/cppunit/TestResult.h:
* include/cppunit/SynchronizedObject.h:
* include/cppunit/extensions/TestCaller.h: doc update.
Diffstat (limited to 'include/cppunit')
| -rw-r--r-- | include/cppunit/Outputter.h | 2 | ||||
| -rw-r--r-- | include/cppunit/SynchronizedObject.h | 6 | ||||
| -rw-r--r-- | include/cppunit/TestCaller.h | 2 | ||||
| -rw-r--r-- | include/cppunit/TestResult.h | 2 | ||||
| -rw-r--r-- | include/cppunit/TestResultCollector.h | 3 | ||||
| -rw-r--r-- | include/cppunit/TextTestRunner.h | 2 |
6 files changed, 12 insertions, 5 deletions
diff --git a/include/cppunit/Outputter.h b/include/cppunit/Outputter.h index 62ee1d0..1805dc9 100644 --- a/include/cppunit/Outputter.h +++ b/include/cppunit/Outputter.h @@ -7,7 +7,7 @@ namespace CppUnit { -/*! This class represents an abstract outputter. +/*! \brief Abstract outputter to print test result summary. */ class CPPUNIT_API Outputter { diff --git a/include/cppunit/SynchronizedObject.h b/include/cppunit/SynchronizedObject.h index dac5792..7ee8447 100644 --- a/include/cppunit/SynchronizedObject.h +++ b/include/cppunit/SynchronizedObject.h @@ -10,7 +10,7 @@ namespace CppUnit /*! \brief Base class for synchronized object. * * Synchronized object are object which members are used concurrently by mutiple - * threads.* + * threads. * * This class define the class SynchronizationObject which must be subclassed * to implement an actual lock. @@ -22,6 +22,8 @@ namespace CppUnit class CPPUNIT_API SynchronizedObject { public: + /*! \brief Abstract synchronization object (mutex) + */ class SynchronizationObject { public: @@ -40,6 +42,8 @@ public: virtual ~SynchronizedObject(); protected: + /*! \brief Locks a synchronization object in the current scope. + */ class ExclusiveZone { SynchronizationObject *m_syncObject; diff --git a/include/cppunit/TestCaller.h b/include/cppunit/TestCaller.h index 525e509..85c12d0 100644 --- a/include/cppunit/TestCaller.h +++ b/include/cppunit/TestCaller.h @@ -12,6 +12,7 @@ namespace CppUnit { +//! \internal class CPPUNIT_API NoExceptionExpected { private: @@ -20,6 +21,7 @@ private: }; +//! \internal template<typename ExceptionType> struct ExpectedExceptionTraits { diff --git a/include/cppunit/TestResult.h b/include/cppunit/TestResult.h index 2bbe322..5351436 100644 --- a/include/cppunit/TestResult.h +++ b/include/cppunit/TestResult.h @@ -22,7 +22,7 @@ class TestListener; template class CPPUNIT_API std::deque<TestListener *>; #endif -/*! Manages TestListener. +/*! \brief Manages TestListener. * * A single instance of this class is used when running the test. It is usually * created by the test runner (TextTestRunner). diff --git a/include/cppunit/TestResultCollector.h b/include/cppunit/TestResultCollector.h index f094f0a..c40282c 100644 --- a/include/cppunit/TestResultCollector.h +++ b/include/cppunit/TestResultCollector.h @@ -22,7 +22,7 @@ namespace CppUnit #endif -/*! +/*! \brief Collects test result. * A TestResultCollector is a TestListener which collects the results of executing * a test case. It is an instance of the Collecting Parameter pattern. * @@ -30,6 +30,7 @@ namespace CppUnit * A failure is anticipated and checked for with assertions. Errors are * unanticipated problems signified by exceptions that are not generated * by the framework. + * \see TestListener, TestFailure. */ class CPPUNIT_API TestResultCollector : public TestSucessListener { diff --git a/include/cppunit/TextTestRunner.h b/include/cppunit/TextTestRunner.h index 7bfc6d9..0d7a138 100644 --- a/include/cppunit/TextTestRunner.h +++ b/include/cppunit/TextTestRunner.h @@ -14,7 +14,7 @@ class TestResult; class TestResultCollector; /*! - * A text mode test runner. + * \brief A text mode test runner. * * The test runner manage the life cycle of the added tests. * |
