]> Creatis software - gdcm.git/blobdiff - src/gdcmException.h
Fix mistypings
[gdcm.git] / src / gdcmException.h
index 1fb07a96e55e3cc1ca7c4fd83403f7a6b9dc26e7..0e46086034dab7f406a9b6fa0dafc88fb5d9e0f9 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmException.h,v $
   Language:  C++
-  Date:      $Date: 2004/10/12 04:35:46 $
-  Version:   $Revision: 1.17 $
+  Date:      $Date: 2007/08/22 16:14:04 $
+  Version:   $Revision: 1.25 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
                                                                                 
 =========================================================================*/
 
-#ifndef GDCM_EXCEPTION_H
-#define GDCM_EXCEPTION_H
+#ifndef _GDCM_EXCEPTION_H_
+#define _GDCM_EXCEPTION_H_
 
 #include "gdcmCommon.h"
+
 #include <string>
 #include <iostream>
 #include <exception>
-namespace gdcm 
+
+namespace GDCM_NAME_SPACE 
 {
 
 //-----------------------------------------------------------------------------
-/*
- * Any exception thrown in the gdcm library
+/**
+ * \brief Any exception thrown in the gdcm library
  */
 class GDCM_EXPORT Exception : public std::exception
 {
 public:
    /*
-    * Builds an exception with minimal information: name of the thrower
-    * method and error message
-    *
+    * \brief Builds an exception with minimal information: name of the thrower
+    *        method and error message
     * @param from name of the thrower
     * @param error error description string
     */
@@ -46,28 +47,24 @@ public:
    /**
     * \brief virtual destructor makes this class dynamic
     */
-   virtual ~Exception() throw() {};
+   virtual ~Exception() throw() {}
 
    /// exception caught within exception class: print error message and die
    static void fatal(const char *from) throw();
 
    /// returns error message
-   const std::string &getError() const throw() {
-      return Error;
-   }
+   const std::string &getError() const throw() { return Error;}
 
    /// try to discover this (dynamic) class name
    virtual std::string getName() const throw();
 
    /// returns exception name string (overloads std::exception::what)
-   virtual const char *what() const throw() {
-      return (const char *) *this;
-   }
+   virtual const char *what() const throw() { return (const char *) *this;}
 
    /// returns exception name string
    operator const char *() const throw();
 
-   friend std::ostreamoperator<<(std::ostream &os, const Exception &e);
+   friend std::ostream &operator<<(std::ostream &os, const Exception &e);
 
 protected:
    /// error message part 1
@@ -78,8 +75,8 @@ protected:
 
 
 //-----------------------------------------------------------------------------
-/*
- * File error exception thrown in the gdcm library
+/**
+ * \brief File error exception thrown in the gdcm library
  */
 class GDCM_EXPORT FileError : public Exception
 {
@@ -108,7 +105,7 @@ public:
    /// @param from name of the thrower
    /// @param error error description string
    explicit FormatUnexpected(const std::string &from,
-                            const std::string &error = "Unexpected file format")
+                             const std::string &error = "Unexpected file format")
       throw() : Exception( from, error ) { }
 };
 
@@ -124,7 +121,7 @@ public:
    /// @param from name of the thrower
    /// @param error error description string
    explicit FormatError(const std::string &from,
-                            const std::string &error = "Invalid file format")
+                        const std::string &error = "Invalid file format")
       throw() : FormatUnexpected( from, error ) { }
 };