diff options
| author | Baptiste Lepilleur <gaiacrtn@free.fr> | 2002-08-29 18:27:07 +0000 |
|---|---|---|
| committer | Baptiste Lepilleur <gaiacrtn@free.fr> | 2002-08-29 18:27:07 +0000 |
| commit | 40669673029364275f58207549f91b8390215ec7 (patch) | |
| tree | 64f006dc0eb826c11c5b85bc24d963b1811ba245 /include/cppunit/plugin/TestPlugIn.h | |
| parent | eb3575761c12af9822403fcf25b6930150fb6890 (diff) | |
| download | cppunit-40669673029364275f58207549f91b8390215ec7.tar.gz | |
Include/cppunit/CompilerOutputter.
include/cppunit/CompilerOutputter.h:
* include/cppunit/Exception.h:
* include/cppunit/Protector.h:
* include/cppunit/TestListener.h:
* include/cppunit/TestPath.h:
* include/cppunit/TestResult.h:
* include/cppunit/TestRunner.h:
* include/cppunit/XmlOutputter.h:
* include/cppunit/plugin/DynamicLibraryManager.h:
* include/cppunit/plugin/PlugInManager.h:
* include/cppunit/plugin/PlugInParameters.h:
* include/cppunit/TestPlugIn.h:
* src/cppunit/DefaultProtector.h:
* src/cppunit/ProtectorChain.h:
* src/cppunit/ProtectorContext.h:
* src/cppunit/TestCase.cpp:
* src/cppunit/TestResult.cpp: fixed a dew documentation bugs.
* include/cppunit/TestResult.h:
* src/cppunit/TestResult.cpp: moved documentation to header.
Diffstat (limited to 'include/cppunit/plugin/TestPlugIn.h')
| -rw-r--r-- | include/cppunit/plugin/TestPlugIn.h | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/include/cppunit/plugin/TestPlugIn.h b/include/cppunit/plugin/TestPlugIn.h index 2f3fdde..b2baf5b 100644 --- a/include/cppunit/plugin/TestPlugIn.h +++ b/include/cppunit/plugin/TestPlugIn.h @@ -42,7 +42,7 @@ CPPUNIT_NS_END */ struct CppUnitTestPlugIn { - /*! Called just after loading the dynamic library. + /*! \brief Called just after loading the dynamic library. * * Override this method to add additional suite to the registry, though this * is preferably done using the macros (CPPUNIT_TEST_SUITE_REGISTRATION...). @@ -58,7 +58,7 @@ struct CppUnitTestPlugIn virtual void initialize( CPPUNIT_NS::TestFactoryRegistry *registry, const CPPUNIT_NS::PlugInParameters ¶meters ) =0; - /*! Gives a chance to the plug-in to register TestListener. + /*! \brief Gives a chance to the plug-in to register TestListener. * * Override this method to add a TestListener for the test run. This is useful * if you are writing a custom TestListener, but also if you need to @@ -67,23 +67,23 @@ struct CppUnitTestPlugIn */ virtual void addListener( CPPUNIT_NS::TestResult *eventManager ) =0; - /*! Gives a chance to the plug-in to remove its registered TestListener. + /*! \brief Gives a chance to the plug-in to remove its registered TestListener. * * Override this method to remove a TestListener that has been added. */ virtual void removeListener( CPPUNIT_NS::TestResult *eventManager ) =0; - /*! Provides a way for the plug-in to register some XmlOutputterHook. + /*! \brief Provides a way for the plug-in to register some XmlOutputterHook. */ virtual void addXmlOutputterHooks( CPPUNIT_NS::XmlOutputter *outputter ) =0; - /*! Called when the XmlOutputter is destroyed. + /*! \brief Called when the XmlOutputter is destroyed. * * Can be used to free some resources allocated by addXmlOutputterHooks(). */ virtual void removeXmlOutputterHooks() = 0; - /*! Called just before unloading the dynamic library. + /*! \brief Called just before unloading the dynamic library. * * Override this method to unregister test factory added in initialize(). * This is necessary to keep the TestFactoryRegistry 'clean'. When @@ -96,7 +96,7 @@ struct CppUnitTestPlugIn -/*! Name of the function exported by a test plug-in. +/*! \brief Name of the function exported by a test plug-in. * \ingroup WritingTestPlugIn * * The signature of the exported function is: @@ -106,13 +106,13 @@ struct CppUnitTestPlugIn */ #define CPPUNIT_PLUGIN_EXPORTED_NAME cppunitTestPlugIn -/*! Type of the function exported by a plug-in. +/*! \brief Type of the function exported by a plug-in. * \ingroup WritingTestPlugIn */ typedef CppUnitTestPlugIn *(*TestPlugInSignature)(); -/*! Implements the function exported by the test plug-in +/*! \brief Implements the function exported by the test plug-in * \ingroup WritingTestPlugIn */ #define CPPUNIT_PLUGIN_EXPORTED_FUNCTION_IMPL( TestPlugInInterfaceType ) \ @@ -172,7 +172,7 @@ typedef CppUnitTestPlugIn *(*TestPlugInSignature)(); -/*! Implements and exports the test plug-in interface. +/*! \brief Implements and exports the test plug-in interface. * \ingroup WritingTestPlugIn * * This macro exports the test plug-in function using the subclass, |
