From: jpr <jpr>
Date: Tue, 31 Aug 2004 15:39:48 +0000 (+0000)
Subject: Doxygenation
X-Git-Tag: Version0.5.bp~2
X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=commitdiff_plain;h=e7809a4522c8491a6df31cc7d878e0506a7a8c90;p=gdcm.git

Doxygenation
---

diff --git a/src/gdcmDicomDirImage.cxx b/src/gdcmDicomDirImage.cxx
index 7d2c5668..ea24f053 100644
--- a/src/gdcmDicomDirImage.cxx
+++ b/src/gdcmDicomDirImage.cxx
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDicomDirImage.cxx,v $
   Language:  C++
-  Date:      $Date: 2004/08/01 02:39:09 $
-  Version:   $Revision: 1.8 $
+  Date:      $Date: 2004/08/31 15:39:48 $
+  Version:   $Revision: 1.9 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -24,7 +24,7 @@
 /**
  * \ingroup gdcmDicomDirImage
  * \brief  Constructor 
- * @param  s  SQ Item holdoing the elements
+ * @param  s  SQ Item holding the elements
  * @param ptagHT pointer to the HTable (gdcmObject needs it 
  *               to build the gdcmDocEntries)
  */
@@ -34,6 +34,12 @@ gdcmDicomDirImage::gdcmDicomDirImage(gdcmSQItem *s, TagDocEntryHT *ptagHT):
    docEntries = s->GetDocEntries();
 }
 
+/**
+ * \ingroup gdcmDicomDirImage
+ * \brief  Constructor 
+ * @param ptagHT pointer to the HTable (gdcmObject needs it 
+ *               to build the gdcmDocEntries)
+ */
 gdcmDicomDirImage::gdcmDicomDirImage(TagDocEntryHT *ptagHT):
    gdcmObject(ptagHT)
 {
diff --git a/src/gdcmDocEntrySet.cxx b/src/gdcmDocEntrySet.cxx
index 44b15f71..abc0885e 100644
--- a/src/gdcmDocEntrySet.cxx
+++ b/src/gdcmDocEntrySet.cxx
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocEntrySet.cxx,v $
   Language:  C++
-  Date:      $Date: 2004/08/31 14:24:47 $
-  Version:   $Revision: 1.17 $
+  Date:      $Date: 2004/08/31 15:39:48 $
+  Version:   $Revision: 1.18 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -216,7 +216,10 @@ gdcmDocEntry* gdcmDocEntrySet::NewDocEntryByNumber(uint16_t group,
    return newEntry;
 }
 
-/// \brief 
+/* \brief
+ * Probabely move, as is, to gdcmDocEntrySet, as a non virtual method
+ * an remove gdcmDocument::NewDocEntryByName
+ */
 gdcmDocEntry *gdcmDocEntrySet::NewDocEntryByName  (std::string const & name)
 {
   gdcmDict *pubDict = gdcmGlobal::GetDicts()->GetDefaultPubDict();
diff --git a/src/gdcmSQItem.h b/src/gdcmSQItem.h
index 540e2538..946581b4 100644
--- a/src/gdcmSQItem.h
+++ b/src/gdcmSQItem.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmSQItem.h,v $
   Language:  C++
-  Date:      $Date: 2004/08/01 00:59:22 $
-  Version:   $Revision: 1.13 $
+  Date:      $Date: 2004/08/31 15:39:48 $
+  Version:   $Revision: 1.14 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -55,8 +55,9 @@ public:
     
    virtual std::string GetEntryByNumber(uint16_t group, uint16_t element);
 
+   /// \brief   returns the ordinal position of a given SQItem
    int GetSQItemNumber() { return SQItemNumber; };
-
+   /// \brief   Sets the ordinal position of a given SQItem
    void SetSQItemNumber(int itemNumber) { SQItemNumber = itemNumber; };
 
 protected: