remove useless comments

[gdcm.git] / src / gdcmDictEntry.h

diff --git a/src/gdcmDictEntry.h b/src/gdcmDictEntry.h
index 1658bb493753a40015cd8f7f5f6a36b1cd0f1ebc..a9129754b38380fc46df9f6b7a2dbcae250aba83 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/11 15:15:38 $
-  Version:   $Revision: 1.28 $
+  Date:      $Date: 2005/02/02 15:07:41 $
+  Version:   $Revision: 1.34 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -26,7 +26,6 @@ namespace gdcm
 
 //-----------------------------------------------------------------------------
 /**
- * \ingroup DictEntry
  * \brief
  * the DictEntry in an element contained by the Dict.
  * It contains :
@@ -41,13 +40,15 @@ class GDCM_EXPORT DictEntry : public Base
 {
 public:
    DictEntry(uint16_t group, 
-             uint16_t element,
+             uint16_t elem,
              TagName const &vr     = GDCM_UNKNOWN,
              TagName const &vm     = GDCM_UNKNOWN,
              TagName const &name   = GDCM_UNKNOWN);
 
-   static TagKey TranslateToKey(uint16_t group, uint16_t element);
+// Print
+   void Print(std::ostream &os = std::cout, std::string const &indent = "");
 
+// Content of DictEntry
    void SetVR(TagName const &vr);
    void SetVM(TagName const &vm);
 
@@ -89,11 +90,14 @@ public:
    /// @return the key.
    const TagName &GetKey() const { return Key; }
 
+// Key creation
+   static TagKey TranslateToKey(uint16_t group, uint16_t elem);
+
 private:
    /// \todo FIXME 
-   ///        where are the group and element used except from building up
+   ///        where are the group and elem used except from building up
    ///        a TagKey. If the answer is nowhere then there is no need
-   ///        to store the group and element independently.
+   ///        to store the group and elem independently.
    ///
    ///        --> EVERYWHERE ! The alternate question would be :
    ///                         What's TagKey used for ?
@@ -105,8 +109,9 @@ private:
    uint16_t Element; // e.g. 0x0103
 
    /// \brief Value Representation i.e. some clue about the nature
-   ///        of the data represented e.g. "FD" short for
-   ///        "Floating Point Double" (see \ref VR)
+   ///        of the data represented e.g. 
+   ///        "FD" short for "Floating Point Double"(see \ref VR)
+   ///        "PN" short for "Person Name"       
    TagName VR;
 
    /*
@@ -157,13 +162,13 @@ private:
     *  - LLO = Left  Lateral Oblique  
     *  .
     */
-  /// \brief Value Multiplicity (e.g. "1", "1-n", "6")
+   /// \brief Value Multiplicity (e.g. "1", "1-n", "6")
    TagName VM; 
 
    /// e.g. "Patient's Name"                    
    TagName Name;      
 
-   /// Redundant with (group, element) but we add it for efficiency purpose.
+   /// Redundant with (group, elem) but we add it for efficiency purpose.
    TagKey  Key;
 };
 } // end namespace gdcm