* src/*.h : add comments

[gdcm.git] / src / gdcmDictEntry.h

diff --git a/src/gdcmDictEntry.h b/src/gdcmDictEntry.h
index fc3817a61eb617dc30fd7f690b5bdbeecdb03d84..682803fb6877d3387b6f06ebd9b0fb4f2e73efc3 100644 (file)
--- a/src/gdcmDictEntry.h
+++ b/src/gdcmDictEntry.h
@@ -5,6 +5,14 @@
 
 #include "gdcmCommon.h"
 
+/*
+ * the gdcmDictEntry in an element contained by the gdcmDict.
+ * It contains :
+ *  - the key referenced by the DICOM norm or the constructor (for private keys)
+ *  - the corresponding name in english (it's equivalent to a label)
+ *  - the owner group
+ *  - etc.
+ */
 class GDCM_EXPORT gdcmDictEntry {
 private:
    // FIXME : were are the group and element used except from building up
@@ -21,6 +29,7 @@ private:
    std::string  name;   // e.g. "Patient_Name"
    TagKey  key;         // Redundant with (group, element) but we add it
                         // on efficiency purposes.
+
        // DCMTK has many fields for handling a DictEntry (see below). What are the
        // relevant ones for gdcmlib ?
        //      struct DBI_SimpleEntry {