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.

7 files changed, 28 insertions, 24 deletions

diff --git a/include/cppunit/Asserter.h b/include/cppunit/Asserter.h
index 8ad783d..94dadaa 100644
--- a/include/cppunit/Asserter.h
+++ b/include/cppunit/Asserter.h
@@ -44,18 +44,18 @@ class Message;
  */
 struct Asserter
 {
-  /*! Throws a Exception with the specified message and location.
+  /*! \brief Throws a Exception with the specified message and location.
    */
   static void CPPUNIT_API fail( const Message &message, 
                                 const SourceLine &sourceLine = SourceLine() );
 
-  /*! Throws a Exception with the specified message and location.
+  /*! \brief Throws a Exception with the specified message and location.
    * \deprecated Use fail( Message, SourceLine ) instead.
    */
   static void CPPUNIT_API fail( std::string message, 
                                 const SourceLine &sourceLine = SourceLine() );
 
-  /*! Throws a Exception with the specified message and location.
+  /*! \brief Throws a Exception with the specified message and location.
    * \param shouldFail if \c true then the exception is thrown. Otherwise
    *                   nothing happen.
    * \param message Message explaining the assertion failiure.
@@ -65,7 +65,7 @@ struct Asserter
                                   const Message &message, 
                                   const SourceLine &sourceLine = SourceLine() );
 
-  /*! Throws a Exception with the specified message and location.
+  /*! \brief Throws a Exception with the specified message and location.
    * \deprecated Use failIf( bool, Message, SourceLine ) instead.
    * \param shouldFail if \c true then the exception is thrown. Otherwise
    *                   nothing happen.
@@ -103,12 +103,13 @@ struct Asserter
                                                   const AdditionalMessage &additionalMessage = AdditionalMessage(),
                                                   const std::string &shortDescription = "equality assertion failed");
 
-  /*! Throws an Exception with the specified message and location.
+  /*! \brief Throws an Exception with the specified message and location.
    * \param expected Text describing the expected value.
    * \param actual Text describing the actual value.
+   * \param sourceLine Location of the assertion.
    * \param additionalMessage Additional message. Usually used to report
    *                          what are the differences between the expected and actual value.
-   * \param sourceLine Location of the assertion.
+   * \param shortDescription Short description for the failure message.
    */
   static void CPPUNIT_API failNotEqual( std::string expected, 
                                         std::string actual, 
@@ -116,14 +117,15 @@ struct Asserter
                                         const AdditionalMessage &additionalMessage = AdditionalMessage(),
                                         std::string shortDescription = "equality assertion failed" );
 
-  /*! Throws an Exception with the specified message and location.
+  /*! \brief Throws an Exception with the specified message and location.
    * \param shouldFail if \c true then the exception is thrown. Otherwise
    *                   nothing happen.
    * \param expected Text describing the expected value.
    * \param actual Text describing the actual value.
+   * \param sourceLine Location of the assertion.
    * \param additionalMessage Additional message. Usually used to report
    *                          where the "difference" is located.
-   * \param sourceLine Location of the assertion.
+   * \param shortDescription Short description for the failure message.
    */
   static void CPPUNIT_API failNotEqualIf( bool shouldFail,
                                           std::string expected, 
diff --git a/include/cppunit/Message.h b/include/cppunit/Message.h
index 80c7cdb..9b12431 100644
--- a/include/cppunit/Message.h
+++ b/include/cppunit/Message.h
@@ -117,18 +117,18 @@ public:
   void addDetail( const Message &message );
 
   /*! \brief Sets the short description.
-   * \param shortDecription New short description.
+   * \param shortDescription New short description.
    */
   void setShortDescription( const std::string &shortDescription );
 
-  /*! Tests if a message is identical to another one.
+  /*! \brief Tests if a message is identical to another one.
    * \param other Message this message is compared to.
    * \return \c true if the two message are identical, \c false otherwise.
    */
   bool operator ==( const Message &other ) const;
 
 
-  /*! Tests if a message is different from another one.
+  /*! \brief Tests if a message is different from another one.
    * \param other Message this message is compared to.
    * \return \c true if the two message are not identical, \c false otherwise.
    */
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
diff --git a/include/cppunit/tools/XmlDocument.h b/include/cppunit/tools/XmlDocument.h
index 8eba6d1..8d3f0c7 100644
--- a/include/cppunit/tools/XmlDocument.h
+++ b/include/cppunit/tools/XmlDocument.h
@@ -25,8 +25,10 @@ class XmlElement;
 class CPPUNIT_API XmlDocument
 {
 public:
-  /*! Constructs a XmlDocument object.
+  /*! \brief Constructs a XmlDocument object.
    * \param encoding Encoding used in the XML file (default is Latin-1, ISO-8859-1 ). 
+   * \param styleSheet Name of the XSL style sheet file used. If empty then no
+   *                   style sheet will be specified in the output.
    */
   XmlDocument( const std::string &encoding = "",
                const std::string &styleSheet = "" );
diff --git a/include/cppunit/tools/XmlElement.h b/include/cppunit/tools/XmlElement.h
index 62d9e73..0b36bd2 100644
--- a/include/cppunit/tools/XmlElement.h
+++ b/include/cppunit/tools/XmlElement.h
@@ -71,7 +71,7 @@ public:
    */
   void setContent( const std::string &content );
 
-  /*! \overload.
+  /*! \overload void setContent( const std::string &content )
    */
   void setContent( int numericContent );
 
@@ -84,7 +84,7 @@ public:
 
   /*! \brief Adds an attribute with the specified numeric value.
    * \param attributeName Name of the attribute. Must not be empty.
-   * \param value Numeric value of the attribute.
+   * \param numericValue Numeric value of the attribute.
    */
   void addAttribute( std::string attributeName,
                      int numericValue );