diff options
| author | Baptiste Lepilleur <gaiacrtn@free.fr> | 2002-08-29 06:36:51 +0000 |
|---|---|---|
| committer | Baptiste Lepilleur <gaiacrtn@free.fr> | 2002-08-29 06:36:51 +0000 |
| commit | eb3575761c12af9822403fcf25b6930150fb6890 (patch) | |
| tree | c66e2a7a138e4ee97d020aab43d6372f6bafe194 /include/cppunit/extensions | |
| parent | edf9c347bd42b7940d39dd70049fb9895d3a3c5a (diff) | |
| download | cppunit-eb3575761c12af9822403fcf25b6930150fb6890.tar.gz | |
Include/cppunit/Asserter.
include/cppunit/Asserter.h:
* include/cppunit/Message.h:
* include/cppunit/extensions/TestNamer.h:
* include/cppunit/extensions/TestSuiteBuilder.h:
* include/cppunit/tools/XmlDocument.h:
* include/cppunit/tools/XmlElement.h: Fixed a few documentation bug.
Diffstat (limited to 'include/cppunit/extensions')
| -rw-r--r-- | include/cppunit/extensions/TestNamer.h | 8 | ||||
| -rw-r--r-- | include/cppunit/extensions/TestSuiteBuilderContext.h | 8 | ||||
| -rw-r--r-- | include/cppunit/extensions/TypeInfoHelper.h | 4 |
3 files changed, 10 insertions, 10 deletions
diff --git a/include/cppunit/extensions/TestNamer.h b/include/cppunit/extensions/TestNamer.h index 5f2e433..fdf1e70 100644 --- a/include/cppunit/extensions/TestNamer.h +++ b/include/cppunit/extensions/TestNamer.h @@ -48,23 +48,23 @@ class CPPUNIT_API TestNamer { public: #if CPPUNIT_HAVE_RTTI - /*! Constructs a namer using the fixture's type-info. + /*! \brief Constructs a namer using the fixture's type-info. * \param typeInfo Type-info of the fixture type. Use to name the fixture suite. */ TestNamer( const std::type_info &typeInfo ); #endif - /*! Constructs a namer using the specified fixture name. + /*! \brief Constructs a namer using the specified fixture name. * \param fixtureName Name of the fixture suite. Usually extracted using a macro. */ TestNamer( const std::string &fixtureName ); - /*! Returns the name of the fixture. + /*! \brief Returns the name of the fixture. * \return Name of the fixture. */ virtual std::string getFixtureName() const; - /*! \Returns the name of the test for the specified method. + /*! \brief Returns the name of the test for the specified method. * \param testMethodName Name of the method that implements a test. * \return A string that is the concatenation of the test fixture name * (returned by getFixtureName()) and\a testMethodName, diff --git a/include/cppunit/extensions/TestSuiteBuilderContext.h b/include/cppunit/extensions/TestSuiteBuilderContext.h index 5f79e29..ec0318c 100644 --- a/include/cppunit/extensions/TestSuiteBuilderContext.h +++ b/include/cppunit/extensions/TestSuiteBuilderContext.h @@ -22,7 +22,7 @@ class TestNamer; class CPPUNIT_API TestSuiteBuilderContextBase { public: - /*! Constructs a new context. + /*! \brief Constructs a new context. * * You should not use this. The context is created in * CPPUNIT_TEST_SUITE(). @@ -31,19 +31,19 @@ public: const TestNamer &namer, TestFixtureFactory &factory ); - /*! Adds a test to the fixture suite. + /*! \brief Adds a test to the fixture suite. * * \param test Test to add to the fixture suite. Must not be \c NULL. */ void addTest( Test *test ); - /*! Returns the fixture name. + /*! \brief Returns the fixture name. * \return Fixture name. It is the name used to name the fixture * suite. */ std::string getFixtureName() const; - /*! Returns the name of the test for the specified method. + /*! \brief Returns the name of the test for the specified method. * * \param testMethodName Name of the method that implements a test. * \return A string that is the concatenation of the test fixture name diff --git a/include/cppunit/extensions/TypeInfoHelper.h b/include/cppunit/extensions/TypeInfoHelper.h index 0c087af..4ee9e86 100644 --- a/include/cppunit/extensions/TypeInfoHelper.h +++ b/include/cppunit/extensions/TypeInfoHelper.h @@ -11,12 +11,12 @@ CPPUNIT_NS_BEGIN - /** Helper to use type_info. + /**! \brief Helper to use type_info. */ class CPPUNIT_API TypeInfoHelper { public: - /** Get the class name of the specified type_info. + /*! \brief Get the class name of the specified type_info. * \param info Info which the class name is extracted from. * \return The string returned by type_info::name() without * the "class" prefix. If the name is not prefixed |
