Added documentation.

1 files changed, 34 insertions, 33 deletions

diff --git a/include/cppunit/Exception.h b/include/cppunit/Exception.h
index 1cf7548..8467c0a 100644
--- a/include/cppunit/Exception.h
+++ b/include/cppunit/Exception.h
@@ -6,57 +6,58 @@
 
 namespace CppUnit {
 
-  /** 
-   * Exception is an exception that serves
-   * descriptive strings through its what() method
-   *
-   */
-
-  class Exception : public std::exception
-  {
+/*! \brief Exceptions thrown by failed assertions.
+ *
+ * Exception is an exception that serves
+ * descriptive strings through its what() method
+ */
+class Exception : public std::exception
+{
+public:
+
+    class Type
+    {
     public:
-      class Type
-      {
-      public:
         Type( std::string type ) : m_type ( type ) {}
 
         bool operator ==( const Type &other ) const
         {
-          return m_type == other.m_type;
+	    return m_type == other.m_type;
         }
-      private:
+    private:
         const std::string m_type;
-      };
+    };
 
 
-      Exception( std::string  message = "", 
-                 long lineNumber = UNKNOWNLINENUMBER, 
-                 std::string fileName = UNKNOWNFILENAME);
-      Exception (const Exception& other);
+    Exception( std::string  message = "", 
+	       long lineNumber = UNKNOWNLINENUMBER, 
+	       std::string fileName = UNKNOWNFILENAME);
+    Exception (const Exception& other);
 
-      virtual ~Exception () throw();
+    virtual ~Exception () throw();
 
-      Exception& operator= (const Exception& other);
+    Exception& operator= (const Exception& other);
 
-      const char *what() const throw ();
+    const char *what() const throw ();
 
-      long lineNumber ();
-      std::string fileName ();
+    long lineNumber ();
+    std::string fileName ();
 
-      static const std::string UNKNOWNFILENAME;
-      static const long UNKNOWNLINENUMBER;
+    static const std::string UNKNOWNFILENAME;
+    static const long UNKNOWNLINENUMBER;
 
-      virtual Exception *clone() const;
+    virtual Exception *clone() const;
+    
+    virtual bool isInstanceOf( const Type &type ) const;
 
-      virtual bool isInstanceOf( const Type &type ) const;
+    static Type type();
 
-      static Type type();
+private:
+    std::string m_message;
+    long m_lineNumber;
+    std::string m_fileName;
+};
 
-    private:
-      std::string m_message;
-      long m_lineNumber;
-      std::string m_fileName;
-  };
 
 } // namespace CppUnit