Doxygenation

[gdcm.git] / src / gdcmDebug.h

diff --git a/src/gdcmDebug.h b/src/gdcmDebug.h
index 1b6d80ce08ae433cf641c0c16b8080290ac2ee53..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/02/09 21:37:45 $
-  Version:   $Revision: 1.31 $
+  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
@@ -36,6 +36,9 @@ namespace gdcm
  *  - 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:
@@ -47,8 +50,8 @@ public:
    Debug();
    ~Debug();
 
-   /// This is a global flag that controls whether any debug, warning
-   /// messages are displayed.
+   /// \brief This is a global flag that controls whether any debug, warning
+   ///        messages are displayed.
    static void SetDebugFlag (bool flag);
    static bool GetDebugFlag ();
    /// \brief Sets the Debug Flag to true
@@ -56,8 +59,8 @@ public:
    /// \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
+   /// \brief This is a global flag that controls if debug are redirected
+   ///        to a file or not
    static void SetDebugToFile (bool flag);
    static bool GetDebugToFile ();
    /// \brief Next debug messages will be sent in the debug file
@@ -99,7 +102,7 @@ public:
  * @param msg message part
  */
 #ifdef NDEBUG
-#define gdcmDebugMacro(msg)
+#define gdcmDebugMacro(msg) {}
 #else
 #define gdcmDebugMacro(msg)                                 \
 {                                                           \
@@ -119,18 +122,18 @@ public:
 #endif //NDEBUG
 
 /**
- * \brief   Verbose 
+ * \brief   Warning
  * @param msg message part
  */
 #ifdef NDEBUG
-#define gdcmWarningMacro(msg)
+#define gdcmWarningMacro(msg) {}
 #else
 #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() )                            \
@@ -146,7 +149,7 @@ public:
  * @param msg second message part 
  */
 #ifdef NDEBUG
-#define gdcmErrorMacro(msg)
+#define gdcmErrorMacro(msg) {}
 #else
 #define gdcmErrorMacro(msg)                                 \
 {                                                           \
@@ -168,7 +171,7 @@ public:
  *        gdcmAssertMacro( "my message" && 2 < 3 )
  */
 #ifdef NDEBUG
-#define gdcmAssertMacro(arg)
+#define gdcmAssertMacro(arg) {}
 #else
 #define gdcmAssertMacro(arg)                                \
 {                                                           \