* Add a RefCounter object that is deleted only when it's reference count is

[gdcm.git] / src / gdcmDebug.cxx

diff --git a/src/gdcmDebug.cxx b/src/gdcmDebug.cxx
index 82ced4141d27c695ad8e4630adafaa88f2ddc7ca..d9a56182e30bb7fcb0ff5bb45e77f96f129570ae 100644 (file)
--- a/src/gdcmDebug.cxx
+++ b/src/gdcmDebug.cxx
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDebug.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/30 17:30:57 $
-  Version:   $Revision: 1.19 $
+  Date:      $Date: 2005/06/24 10:55:58 $
+  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
@@ -21,16 +21,14 @@
 
 namespace gdcm 
 {
-
-/// warning message level to be displayed
+//-----------------------------------------------------------------------------
+// Warning message level to be displayed
 static bool DebugFlag   = false;
 static bool DebugToFile = false;
 static std::ofstream DebugFile;
 
-
 //-----------------------------------------------------------------------------
 // Constructor / Destructor
-
 Debug::Debug()
 {
 
@@ -42,15 +40,10 @@ Debug::~Debug()
       DebugFile.close();     
 }
 
-//-----------------------------------------------------------------------------
-// Print
-
-
 //-----------------------------------------------------------------------------
 // Public
-
 /**
- * \brief   Accessor
+ * \brief   Sets the debug flag
  * @param   flag Set the debug flag
  */ 
 void Debug::SetDebugFlag (bool flag) 
@@ -59,8 +52,8 @@ void Debug::SetDebugFlag (bool flag)
 }
 
 /**
- * \brief   Accessor
- * @param   level Get the debug flag
+ * \brief   Gets the debug flag value
+ * @return debug flag value
  */ 
 bool Debug::GetDebugFlag ()
 {
@@ -69,7 +62,7 @@ bool Debug::GetDebugFlag ()
 
 /**
  * \brief   Accessor
- * @param   flag Set the debug flag to redirect to file
+ * @param   flag whether we want to redirect to file
  */ 
 void Debug::SetDebugToFile (bool flag) 
 {
@@ -77,8 +70,7 @@ void Debug::SetDebugToFile (bool flag)
 }
 
 /**
- * \brief   Accessor
- * @param   level Get the debug flag to redirect to file
+ * \brief   Accessor to know whether debug info are redirected to file
  */ 
 bool Debug::GetDebugToFile ()
 {
@@ -86,22 +78,24 @@ bool Debug::GetDebugToFile ()
 }
 
 /**
- * \brief   Set Accessor
- * @param   flag Set the debug flag to redirect to file
+ * \brief Set the filename the debug stream should be redirect to
+ *        Settting a filename also sets DebugToFile to true
+ * @param   filename  File to redirect debug info
  *          Absolutely nothing is check. You have to pass in
  *          a correct filename
  */ 
 void Debug::SetDebugFilename (std::string const &filename)
 {
    DebugToFile = true;  // Just in case ... 
-   DebugFlag = true;    // Just in case ...
-   if( DebugFile.is_open() )
+   DebugFlag   = true;  // Just in case ...
+   if ( DebugFile.is_open() )
       DebugFile.close();
    DebugFile.open( filename.c_str() );
 }
 
 /**
- * \brief   Get Accessor
+ * \brief Internal use only. Allow us to retrieve the static from anywhere
+ *        in gdcm code
  * @return Debug file
  */
 std::ofstream &Debug::GetDebugFile ()
@@ -116,6 +110,7 @@ std::ofstream &Debug::GetDebugFile ()
 // Private
    
 //-----------------------------------------------------------------------------
-} // end namespace gdcm
-
+// Print
 
+//-----------------------------------------------------------------------------
+} // end namespace gdcm