ENH: First pass at simplifying the JPEG stuff.

[gdcm.git] / src / gdcmDictEntry.h

diff --git a/src/gdcmDictEntry.h b/src/gdcmDictEntry.h
index ac0250ee6695b99a4f37cb6172453b300a4c0b1e..5fc005d980b959f5f8e49d89798e027d84ec3984 100644 (file)
--- a/src/gdcmDictEntry.h
+++ b/src/gdcmDictEntry.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDictEntry.h,v $
   Language:  C++
-  Date:      $Date: 2005/01/07 16:14:58 $
-  Version:   $Revision: 1.27 $
+  Date:      $Date: 2005/01/16 04:50:41 $
+  Version:   $Revision: 1.30 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -25,15 +25,17 @@ namespace gdcm
 {
 
 //-----------------------------------------------------------------------------
-/*
- * \defgroup DictEntry
+/**
+ * \ingroup DictEntry
  * \brief
  * the DictEntry in an element contained by the Dict.
  * 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.
+ *    i.e. the Group number
+ *         the Element number
+ *  - the VR (Value Representation)
+ *  - the VM (Value Multplicity)
+ *  - the corresponding name in english
  */
 class GDCM_EXPORT DictEntry : public Base
 {
@@ -44,8 +46,13 @@ public:
              TagName const &vm     = GDCM_UNKNOWN,
              TagName const &name   = GDCM_UNKNOWN);
 
+// Print
+   void Print(std::ostream &os = std::cout, std::string const &indent = "");
+
+// Key creation
    static TagKey TranslateToKey(uint16_t group, uint16_t element);
 
+// Content of DictEntry
    void SetVR(TagName const &vr);
    void SetVM(TagName const &vm);