]> Creatis software - gdcm.git/commitdiff
Doxygenation
authorjpr <jpr>
Tue, 31 Aug 2004 15:39:48 +0000 (15:39 +0000)
committerjpr <jpr>
Tue, 31 Aug 2004 15:39:48 +0000 (15:39 +0000)
src/gdcmDicomDirImage.cxx
src/gdcmDocEntrySet.cxx
src/gdcmSQItem.h

index 7d2c5668f48872f372df53459ee803d8c0d92afa..ea24f053a27818e910dd8fabd0650e3286942f6c 100644 (file)
@@ -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)
 {
index 44b15f712658fe4f1995b95f82988a4727bac2df..abc0885ecae368ccdc1c425b03cfd1a583113041 100644 (file)
@@ -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();
index 540e2538303b10435e803d2323c3571644bbd5b2..946581b4a6f10723f2d9bba10035df2b342dd028 100644 (file)
@@ -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: