* src/*.h : add comments

[gdcm.git] / src / gdcmUtil.h

diff --git a/src/gdcmUtil.h b/src/gdcmUtil.h
index ea5eb165654ce61f01c8fd38020a7010276c545e..2e4696258e524baddc8fd267ea68a42a12279ad5 100644 (file)
--- a/src/gdcmUtil.h
+++ b/src/gdcmUtil.h
@@ -1,22 +1,31 @@
-// $Header: /cvs/public/gdcm/src/gdcmUtil.h,v 1.13 2003/07/01 10:04:36 frog Exp $
+// $Header: /cvs/public/gdcm/src/gdcmUtil.h,v 1.17 2004/01/12 13:12:28 regrain Exp $
 
 #ifndef GDCMUTIL_H
 #define GDCMUTIL_H
 
-#include <iostream>
-#include <vector>
-#include <string>
 #include "gdcmVR.h"
 #include "gdcmTS.h"
 #include "gdcmDictSet.h"
+#include <iostream>
+#include <vector>
+#include <string>
 
+/*
+ * gdcmDebug is an object for debugging in program.
+ * It has 2 debugging modes :
+ *  - error : for bad library use
+ *  - debug : for debugging messages
+ * 
+ * A debugging message has a level of priority and is 
+ * Shown only when the debug level is higher than the 
+ * message level.
+ */
 class gdcmDebug {
 private:
        int DebugLevel;
 public:
        gdcmDebug(int  = 0);
        void Verbose(int, const char*, const char* ="");
-//     void Verbose(int, char*, char*);
        void Error(bool, const char*,  const char* ="");
        void Error(const char*, const char* ="", const char* ="");
        void Assert(int, bool, const char*, const char*);
@@ -24,6 +33,10 @@ public:
        void SetDebug (int i) {DebugLevel = i;}
 };
 
+/*
+ * This class contains all globals elements that might be
+ * instanciated only one time
+ */
 class gdcmGlobal {
 private:
    static gdcmVR *VR;
@@ -46,7 +59,7 @@ void Tokenize (const std::string& str,
 extern gdcmDebug dbg;
 
 char * _cleanString(char *v);
-char * _CreateCleanString(std::string s);
+std::string _CreateCleanString(std::string s);
 
 std::string TranslateToKey(guint16 group, guint16 element);