Doxygenation

[gdcm.git] / src / gdcmDebug.h

diff --git a/src/gdcmDebug.h b/src/gdcmDebug.h
index edb114fd5f05420043d3401c7ee4f93e8aaae5fa..5f834ce192c8373a0fe8d7c96b14320020bc932e 100644 (file)
--- a/src/gdcmDebug.h
+++ b/src/gdcmDebug.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDebug.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/31 12:19:33 $
-  Version:   $Revision: 1.26 $
+  Date:      $Date: 2005/06/21 14:05:06 $
+  Version:   $Revision: 1.35 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -31,12 +31,14 @@ namespace gdcm
 //-----------------------------------------------------------------------------
 
 /**
- * \ingroup Debug
  * \brief Debug is an object for debugging in program.
  * It has 2 debugging modes :
  *  - error : for bad library use, seriously wrong DICOM
  *  - debug : for information/debug messages
  *  - warning : for warning about DICOM quality (kosher)
+ *  - assert : design by contract implementation. A function should have 
+ *             proper input and proper output. 
+ *             (should not happen, not user controlled)
  * 
  * A debugging message is only show if the flag is on (DebugFlag)
  * This is static var and can be set at beginning of code:
@@ -48,26 +50,26 @@ public:
    Debug();
    ~Debug();
 
-   /// This is a global flag that controls whether any debug, warning
-   /// messages are displayed.
-   static bool GetDebugFlag ();
+   /// \brief This is a global flag that controls whether any debug, warning
+   ///        messages are displayed.
    static void SetDebugFlag (bool flag);
-   static void SetDebugOn  () { SetDebugFlag(true);  };
-   static void SetDebugOff () { SetDebugFlag(false); };
+   static bool GetDebugFlag ();
+   /// \brief Sets the Debug Flag to true
+   static void DebugOn  () { SetDebugFlag(true);  };
+   /// \brief Sets the Debug Flag to false
+   static void DebugOff () { SetDebugFlag(false); };
 
-   /// This is a global flag that controls if debug are redirected
-   /// to a file or not
-   static bool GetDebugToFile ();
+   /// \brief This is a global flag that controls if debug are redirected
+   ///        to a file or not
    static void SetDebugToFile (bool flag);
-   static void SetDebugToFileOn  () { SetDebugToFile(true);  };
-   static void SetDebugToFileOff () { SetDebugToFile(false); };
+   static bool GetDebugToFile ();
+   /// \brief Next debug messages will be sent in the debug file
+   static void DebugToFileOn  () { SetDebugToFile(true);  };
+   /// \brief Next debug messages will be sent in the standard output
+   static void DebugToFileOff () { SetDebugToFile(false); };
 
-   /// Set the filename the debug stream should be redirect to
-   /// Settting a filename also set DebugToFile to true
-   static void SetDebugFilename (std::string const& filename);
+   static void SetDebugFilename (std::string const &filename);
 
-   /// Internal use only. Allow us to retrieve the static from anywhere
-   /// in gdcm code
    static std::ofstream &GetDebugFile ();
 };
 
@@ -100,7 +102,7 @@ public:
  * @param msg message part
  */
 #ifdef NDEBUG
-#define gdcmDebugMacro(msg)
+#define gdcmDebugMacro(msg) {}
 #else
 #define gdcmDebugMacro(msg)                                 \
 {                                                           \
@@ -120,20 +122,18 @@ public:
 #endif //NDEBUG
 
 /**
- * \brief   Verbose 
+ * \brief   Warning
  * @param msg message part
  */
 #ifdef NDEBUG
-#define gdcmVerboseMacro(msg)                               \
-{                                                           \
-}
+#define gdcmWarningMacro(msg) {}
 #else
-#define gdcmVerboseMacro(msg)                               \
+#define gdcmWarningMacro(msg)                               \
 {                                                           \
    if( Debug::GetDebugFlag() )                              \
    {                                                        \
    std::ostringstream osmacro;                              \
-   osmacro << "Verbose: In " __FILE__ ", line " << __LINE__ \
+   osmacro << "Warning: In " __FILE__ ", line " << __LINE__ \
            << ", function " << GDCM_FUNCTION << "\n"        \
            << msg << "\n\n";                                \
    if( Debug::GetDebugToFile() )                            \
@@ -149,7 +149,7 @@ public:
  * @param msg second message part 
  */
 #ifdef NDEBUG
-#define gdcmErrorMacro(msg)
+#define gdcmErrorMacro(msg) {}
 #else
 #define gdcmErrorMacro(msg)                                 \
 {                                                           \
@@ -171,7 +171,7 @@ public:
  *        gdcmAssertMacro( "my message" && 2 < 3 )
  */
 #ifdef NDEBUG
-#define gdcmAssertMacro(arg)
+#define gdcmAssertMacro(arg) {}
 #else
 #define gdcmAssertMacro(arg)                                \
 {                                                           \