ENH: Minor patch, mostly cosmetic clean up

[gdcm.git] / src / gdcmException.cxx

diff --git a/src/gdcmException.cxx b/src/gdcmException.cxx
index d2d3d7cd030221b5c11ba898d5998cff8c5080eb..037156051d30ba1abb35afe9a428e66aeca620f5 100644 (file)
--- a/src/gdcmException.cxx
+++ b/src/gdcmException.cxx
@@ -1,9 +1,35 @@
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmException.cxx,v $
+  Language:  C++
+  Date:      $Date: 2004/06/20 18:08:47 $
+  Version:   $Revision: 1.16 $
+                                                                                
+  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.
+                                                                                
+=========================================================================*/
 
 #include "gdcmException.h"
 
 #include <typeinfo>
 #include <stdio.h>
 
+//-----------------------------------------------------------------------------
+// gdcmException
+
+/**
+ * \ingroup gdcmException
+ * \brief constructor
+ * @param f
+ * @param msg  
+ */
 gdcmException::gdcmException(const std::string &f, const std::string& msg) throw()
 #ifdef __GNUC__
   try
@@ -17,8 +43,12 @@ catch(...) {
 #endif
 
 
-
-void gdcmException::fatal(const char *from) throw() {
+/**
+ * \ingroup gdcmException
+ * \brief fatal
+ * @param from 
+ */
+ void gdcmException::fatal(const char *from) throw() {
   try {
     std::cerr << "Fatal: exception received in " << from 
         << " while handling exception." << std::endl;
@@ -36,8 +66,12 @@ void gdcmException::fatal(const char *from) throw() {
   }  
 }
 
-
-std::string gdcmException::getName() const throw() {
+/**
+ * \ingroup gdcmException
+ * \brief getName
+ * @return string
+ */
+ std::string gdcmException::getName() const throw() {
   try {
 #ifdef __GNUC__   // GNU C++ compiler class name demangling
       unsigned int nested = 1, i, nb, offset;
@@ -57,7 +91,7 @@ std::string gdcmException::getName() const throw() {
        iname = std::string(iname, nb, std::string::npos);
       }
       return name;
-#else             // no class name demangling
+#else           // no class name demangling
       //name = typeid(*this).name();
       return "Exception";
 #endif
@@ -68,13 +102,20 @@ std::string gdcmException::getName() const throw() {
   }
 }
 
-
-gdcmException::operator const char *() const throw() {
+/**
+ * \ingroup gdcmException
+ * \brief gdcmException
+ */
+ gdcmException::operator const char *() const throw() {
   return getName().c_str();
 }
 
-
-std::ostream& operator<<(std::ostream &os, const gdcmException &e) {
+//-----------------------------------------------------------------------------
+/**
+ * \ingroup gdcmException
+ * \brief gdcmException::operator <<
+ */
+ std::ostream& operator<<(std::ostream &os, const gdcmException &e) {
   try {  
     os << "Exception " << e.getName() << " thrown: " << e.getError() << std::endl;
   }
@@ -84,4 +125,4 @@ std::ostream& operator<<(std::ostream &os, const gdcmException &e) {
   return os;
 }
 
-  
+//-----------------------------------------------------------------------------