From a93b48c4c573b00622ded9c58ed848d6048bc0f5 Mon Sep 17 00:00:00 2001
From: jpr <jpr>
Date: Sun, 23 Oct 2005 14:56:27 +0000
Subject: [PATCH] Doxygenation

---
 src/gdcmTagKey.h | 16 +++++++++-------
 src/gdcmVR.cxx   | 24 ++++++++++++------------
 src/gdcmVR.h     |  5 +++--
 3 files changed, 24 insertions(+), 21 deletions(-)

diff --git a/src/gdcmTagKey.h b/src/gdcmTagKey.h
index 2628a848..7ebba4ca 100644
--- a/src/gdcmTagKey.h
+++ b/src/gdcmTagKey.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmTagKey.h,v $
   Language:  C++
-  Date:      $Date: 2005/10/20 13:58:18 $
-  Version:   $Revision: 1.3 $
+  Date:      $Date: 2005/10/23 14:59:43 $
+  Version:   $Revision: 1.4 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -32,7 +32,8 @@ namespace gdcm
 class TagKey
 {
 public :
-   inline TagKey(const uint16_t &gr, const uint16_t &elt) { tag[0] = gr;tag[1] = elt;}
+   inline TagKey(const uint16_t &gr, const uint16_t &elt)
+                                                    { tag[0] = gr;tag[1] = elt;}
    inline TagKey() { tag[0] = tag[1] = 0x0000;}
 
    friend std::ostream& operator<<(std::ostream& _os, const TagKey &_val);
@@ -44,11 +45,11 @@ public :
       return std::string(res);
    }
 
-   inline void SetGroup(const uint16_t &val) { tag[0] = val; }
+   inline void SetGroup(const uint16_t &group) { tag[0] = group; }
    inline const uint16_t &GetGroup(void) { return tag[0]; }
 
-   inline void SetElement(const uint16_t &val) { tag[1] = val; }
-   inline const uint16_t &GetElement(void) { return tag[1]; }
+   inline void SetElement(const &uint16_t elem) { tag[1] = elem; }
+   inline const uint16_t GetElement(void) { return tag[1]; }
 
    inline TagKey &operator=(const TagKey &_val)
    {
@@ -80,7 +81,8 @@ public :
 
    inline bool operator<(const TagKey &_val) const
    {
-      return tag[0] < _val.tag[0] || (tag[0] == _val.tag[0] && tag[1] < _val.tag[1]);
+      return tag[0] < _val.tag[0] || (tag[0] == 
+                                           _val.tag[0] && tag[1] < _val.tag[1]);
    }
 
 private :
diff --git a/src/gdcmVR.cxx b/src/gdcmVR.cxx
index 29670812..03150d58 100644
--- a/src/gdcmVR.cxx
+++ b/src/gdcmVR.cxx
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmVR.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/10/21 08:28:03 $
-  Version:   $Revision: 1.45 $
+  Date:      $Date: 2005/10/23 14:56:27 $
+  Version:   $Revision: 1.46 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -91,13 +91,6 @@ VR::~VR()
  */
 bool VR::IsVROfBinaryRepresentable(VRKey const &tested)
 {
-   //if ( tested == GDCM_UNKNOWN)
-   //{
-   //std::cout << "---------- never used --------------" << tested 
-   //          << std::endl;
-   //   return true;
-   //}
-
    if ( IsVROfStringRepresentable(tested) )
       return false;
 
@@ -109,12 +102,17 @@ bool VR::IsVROfBinaryRepresentable(VRKey const &tested)
 
 /**
  * \brief   Simple predicate that checks whether the given argument
- *          corresponds to the Value Representation of a representable
- *          string.
+ *          corresponds to the Value Representation of a
+ *          'std::string representable' value.
  * @param   tested value representation to be checked.
  */
 bool VR::IsVROfStringRepresentable(VRKey const &tested)
 {
+   //FIXME : either you consider than US, UL, SS, SL *are* string representable
+   //                            and you have to add FD and FL
+   //        or  you consider they are not, and you have to remove them
+   // (I cannot guess your point, reading gdcmDataEntry code :-( )  JPR
+ 
    return tested == "AE" ||
           tested == "AS" ||
           tested == "CS" ||
@@ -141,10 +139,11 @@ bool VR::IsVROfStringRepresentable(VRKey const &tested)
           tested != "OB" &&
           tested != "OW" &&
           tested != "AT" && // Attribute Tag ?!?
+          tested != "UN" && // UN is an actual VR !
           tested != "SQ" ;
 */
 }
-
+/// \brief returns the length of a elementary elem whose VR is passed
 unsigned short VR::GetAtomicElementLength(VRKey const &tested)
 {
    // Unsigned & signed short
@@ -167,6 +166,7 @@ unsigned short VR::GetAtomicElementLength(VRKey const &tested)
 
 // VS6 need a single implementation in the dll
 #if defined(_MSC_VER) && (_MSC_VER == 1200)
+/// \brief checks is a supposed-to-be VR is a 'legal' one.
 bool VR::IsValidVR(VRKey const &key)
 {
   return vr.find(key) != vr.end();
diff --git a/src/gdcmVR.h b/src/gdcmVR.h
index 8728d51b..399884c2 100644
--- a/src/gdcmVR.h
+++ b/src/gdcmVR.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmVR.h,v $
   Language:  C++
-  Date:      $Date: 2005/10/20 14:45:11 $
-  Version:   $Revision: 1.23 $
+  Date:      $Date: 2005/10/23 14:56:27 $
+  Version:   $Revision: 1.24 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -61,6 +61,7 @@ public:
 #if defined(_MSC_VER) && (_MSC_VER == 1200)
    bool IsValidVR(VRKey const &key);
 #else
+/// \brief checks is a supposed-to-be VR is a 'legal' one.
    bool IsValidVR(VRKey const &key) { return vr.find(key) != vr.end(); }
 #endif
 
-- 
2.48.1