]> Creatis software - gdcm.git/blobdiff - src/gdcmDictSet.h
* gdcmPython/__init__.py doesn't crash anymore when running in
[gdcm.git] / src / gdcmDictSet.h
index 0e2aed0b3a39a207fc4c6dface09f26b3f28b9fd..3ccc09d97f26fbcc36953643644b4d9f0e428100 100644 (file)
@@ -5,25 +5,27 @@
 
 #include <map>
 #include <list>
-#include "gdcmCommon.h"
 #include "gdcmDict.h"
 
-////////////////////////////////////////////////////////////////////////////
-// Container for managing a set of loaded dictionaries. Sharing dictionaries
-// should avoid :
-// * reloading an allready loaded dictionary,
-// * having many in memory representations of the same dictionary.
-
 typedef string DictKey;
 typedef map<DictKey, gdcmDict*> DictSetHT;
 
+/*
+ * \defgroup gdcmDictSet
+ * \brief  Container for managing a set of loaded dictionaries.
+ * \note   Hopefully, sharing dictionaries should avoid
+ * \par    reloading an allready loaded dictionary (saving time)
+ * \par    having many in memory representations of the same dictionary
+ *        (saving memory).
+ */
 class GDCM_EXPORT gdcmDictSet {
 private:
        DictSetHT dicts;
        int AppendDict(gdcmDict* NewDict);
        void LoadDictFromFile(string filename, DictKey);
 private:
-       static string DictPath;      // Directory path to dictionaries
+   /// Directory path to dictionaries
+       static string DictPath;
        static string BuildDictPath(void);
        static gdcmDict* DefaultPubDict;
 public:
@@ -31,7 +33,6 @@ public:
        static map<string, list<string> >* GetPubDictTagNamesByCategory(void);
        static gdcmDict* LoadDefaultPubDict(void);
 
-       gdcmDictSet(void);
        // TODO Swig int LoadDictFromFile(string filename);
    // QUESTION: the following function might not be thread safe !? Maybe
    //           we need some mutex here, to avoid concurent creation of
@@ -39,7 +40,7 @@ public:
        // TODO Swig int LoadDictFromName(string filename);
        // TODO Swig int LoadAllDictFromDirectory(string DirectoryName);
        // TODO Swig string* GetAllDictNames();
-       //
+       gdcmDictSet(void);
        void Print(ostream&);
        gdcmDict* GetDict(DictKey DictName);
        gdcmDict* GetDefaultPubDict(void);