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.

4 files changed, 22 insertions, 19 deletions

diff --git a/include/cppunit/plugin/DynamicLibraryManager.h b/include/cppunit/plugin/DynamicLibraryManager.h
index afb0b4a..b93ebad 100644
--- a/include/cppunit/plugin/DynamicLibraryManager.h
+++ b/include/cppunit/plugin/DynamicLibraryManager.h
@@ -36,7 +36,7 @@ public:
   typedef void *Symbol;
   typedef void *LibraryHandle;
 
-  /*! Loads the specified library.
+  /*! \brief Loads the specified library.
    * \param libraryFileName Name of the library to load.
    * \exception DynamicLibraryManagerException if a failure occurs while loading
    *            the library (fail to found or load the library).
@@ -46,7 +46,7 @@ public:
   /// Releases the loaded library..
   ~DynamicLibraryManager();
 
-  /*! Returns a pointer on the specified symbol exported by the library.
+  /*! \brief Returns a pointer on the specified symbol exported by the library.
    * \param symbol Name of the symbol exported by the library.
    * \return Pointer on the symbol. Should be casted to the actual type. Never \c NULL.
    * \exception DynamicLibraryManagerException if the symbol is not found.
diff --git a/include/cppunit/plugin/PlugInManager.h b/include/cppunit/plugin/PlugInManager.h
index 6baaa2b..a2b8e15 100644
--- a/include/cppunit/plugin/PlugInManager.h
+++ b/include/cppunit/plugin/PlugInManager.h
@@ -33,7 +33,7 @@ public:
   /// Destructor.
   virtual ~PlugInManager();
 
-  /*! Loads the specified plug-in.
+  /*! \brief Loads the specified plug-in.
    *
    * After being loaded, the CppUnitTestPlugIn::initialize() is called.
    *
@@ -46,28 +46,28 @@ public:
   void load( const std::string &libraryFileName,
              const PlugInParameters &parameters = PlugInParameters() );
 
-  /*! Unloads the specified plug-in.
+  /*! \brief Unloads the specified plug-in.
    * \param libraryFileName Name of the file that contains the TestPlugIn passed
    *                        to a previous call to load().
    */
   void unload( const std::string &libraryFileName );
 
-  /*! Gives a chance to each loaded plug-in to register TestListener.
+  /*! \brief Gives a chance to each loaded plug-in to register TestListener.
    *
    * For each plug-in, call CppUnitTestPlugIn::addListener().
    */
   void addListener( TestResult *eventManager );
 
-  /*! Gives a chance to each loaded plug-in to unregister TestListener.
+  /*! \brief Gives a chance to each loaded plug-in to unregister TestListener.
    * For each plug-in, call CppUnitTestPlugIn::removeListener().
    */
   void removeListener( TestResult *eventManager );
 
-  /*! Provides a way for the plug-in to register some XmlOutputterHook.
+  /*! \brief Provides a way for the plug-in to register some XmlOutputterHook.
    */
   void addXmlOutputterHooks( XmlOutputter *outputter );
 
-  /*! Called when the XmlOutputter is destroyed.
+  /*! \brief Called when the XmlOutputter is destroyed.
    * 
    * Can be used to free some resources allocated by addXmlOutputterHooks().
    */
diff --git a/include/cppunit/plugin/PlugInParameters.h b/include/cppunit/plugin/PlugInParameters.h
index 9a6f075..c67d0f1 100644
--- a/include/cppunit/plugin/PlugInParameters.h
+++ b/include/cppunit/plugin/PlugInParameters.h
@@ -10,14 +10,17 @@
 
 CPPUNIT_NS_BEGIN
 
-
+/*! \brief Test plug-ins parameters.
+ */
 class CPPUNIT_API PlugInParameters
 {
 public:
+  /// Constructs plug-in parameters from the specified command-line.
   PlugInParameters( const std::string &commandLine = "" );
 
   virtual ~PlugInParameters();
 
+  /// Returns the command line that was passed on construction.
   std::string getCommandLine() const;
 
 private:
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 &parameters ) =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,