]> Creatis software - gdcm.git/commitdiff
Doxygenation
authorjpr <jpr>
Fri, 21 Oct 2005 07:38:57 +0000 (07:38 +0000)
committerjpr <jpr>
Fri, 21 Oct 2005 07:38:57 +0000 (07:38 +0000)
src/gdcmDicomEntry.cxx
src/gdcmDocument.cxx
src/gdcmSerieHelper.cxx

index 9a3923c34956db1585c01ddd09e4488df1176c89..ef260fba115243b440548f26943042a2e30021af 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDicomEntry.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/10/20 08:58:17 $
-  Version:   $Revision: 1.2 $
+  Date:      $Date: 2005/10/21 07:38:57 $
+  Version:   $Revision: 1.3 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -33,14 +33,12 @@ namespace gdcm
  * @param   group      DICOM-Group Number
  * @param   elem       DICOM-Element Number
  * @param   vr         Value Representation
- * @param   vm         Value Multiplicity 
- * @param   name       description of the element
 */
-DicomEntry::DicomEntry(const uint16_t &group,const uint16_t &elt,
+DicomEntry::DicomEntry(const uint16_t &group,const uint16_t &elem,
                        const VRKey &vr)
 {
    Tag.SetGroup(group);
-   Tag.SetElement(elt);
+   Tag.SetElement(elem);
    VR = vr;
 }
 
index 4a82467dc7b63a8d593423cf383a59db1c249745..3dc2920c89d7b885cef9f363e393b0d64210fd76 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocument.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/10/20 15:24:09 $
-  Version:   $Revision: 1.301 $
+  Date:      $Date: 2005/10/21 07:38:58 $
+  Version:   $Revision: 1.302 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -660,7 +660,7 @@ void Document::LoadEntryBinArea(uint16_t group, uint16_t elem)
 /**
  * \brief Loads (from disk) the element content 
  *        when a string is not suitable
- * @param elem  Entry whose binArea is going to be loaded
+ * @param entry  Entry whose binArea is going to be loaded
  */
 void Document::LoadEntryBinArea(DataEntry *entry) 
 {
index f62883e9c08f4f5b6c67428e41bb0222a47c941b..9fef62c65e472e53f3c2c4ab6edf6bebd9c40de2 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmSerieHelper.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/10/18 08:35:50 $
-  Version:   $Revision: 1.24 $
+  Date:      $Date: 2005/10/21 07:38:58 $
+  Version:   $Revision: 1.25 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -152,7 +152,7 @@ void SerieHelper::AddFileName(std::string const &filename)
  *        of the gdcm::SerieHelper.
  * \warning : this method should be used by aware users only!
  *           Passing a gdcm::File* has the same effect than passing a file name!
- * \TODO : decide which one is wrong (the method, or the commentary)!
+ * \todo : decide which one is wrong (the method, or the commentary)!
  *           the following comment doesn't match the method :-(
  *            User is supposed to know the files he want to deal with
  *           and consider them they belong to the same Serie
@@ -535,6 +535,8 @@ XCoherentFileSetmap SerieHelper::SplitOnPosition(FileList *fileSet)
  * \brief   Splits a SingleSerieUID File set Coherent according to the
  *          value of a given Tag
  * @param fileSet File Set to be splitted
+ * @param   group  group number of the target Element
+ * @param   elem element number of the target Element
  * \return  std::map of 'Xcoherent' File sets
  */