]> Creatis software - gdcm.git/blobdiff - src/gdcmException.h
BUG: Need to lean c++ (bug in g++ ?)
[gdcm.git] / src / gdcmException.h
index 436d664a3dfd412d372f6ead94806655a8d430e3..95d9a3c56115ee3b6fc85c2ccdc450b9d7d84fa4 100644 (file)
@@ -1,5 +1,21 @@
-// gdcmException.h
-//-----------------------------------------------------------------------------
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmException.h,v $
+  Language:  C++
+  Date:      $Date: 2004/06/20 18:08:47 $
+  Version:   $Revision: 1.13 $
+                                                                                
+  Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
+  l'Image). All rights reserved. See Doc/License.txt or
+  http://www.creatis.insa-lyon.fr/Public/Gdcm/License.htm for details.
+                                                                                
+     This software is distributed WITHOUT ANY WARRANTY; without even
+     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+     PURPOSE.  See the above copyright notices for more information.
+                                                                                
+=========================================================================*/
+
 #ifndef GDCM_EXCEPTION_H
 #define GDCM_EXCEPTION_H
 
@@ -24,37 +40,37 @@ public:
    explicit gdcmException(const std::string &from, const std::string &error = "")
     throw();
 
-   /*
-    * virtual destructor makes this class dynamic
+   /**
+    * \brief virtual destructor makes this class dynamic
     */
    virtual ~gdcmException() throw() {
    }
 
-   // exception caught within exception class: print error message and die
+   /// exception caught within exception class: print error message and die
    static void fatal(const char *from) throw();
 
-   // returns error message
+   /// returns error message
    const std::string &getError(void) const throw() {
     return error;
    }
 
-   // try to discover this (dynamic) class name
+   /// try to discover this (dynamic) class name
    virtual std::string getName() const throw();
 
-   // returns exception name string (overloads std::exception::what)
+   /// returns exception name string (overloads std::exception::what)
    virtual const char *what() const throw() {
     return (const char *) *this;
    }
 
-   // returns exception name string
+   /// returns exception name string
    operator const char *() const throw();
 
    friend std::ostream& operator<<(std::ostream &os, const gdcmException &e);
 
 protected:
-   // error message
+   /// error message part 1
    std::string from;
-   // error message
+   /// error message part 2
    std::string error;
 };
 
@@ -65,10 +81,9 @@ protected:
  */
 class GDCM_EXPORT gdcmFileError : public gdcmException {
 public:
-   /*
-    * Builds an file-related exception with minimal information: name of
-    * the thrower method and error message
-    *
+   /**
+    * \brief Builds an file-related exception with minimal information: name of
+    *               the thrower method and error message
     * @param from name of the thrower
     * @param error error description string
     */