Doxgenation :

[gdcm.git] / src / gdcmSerieHelper.h

diff --git a/src/gdcmSerieHelper.h b/src/gdcmSerieHelper.h
index 693b82a67e105fea5233307260eec792fc063e20..6b91c5bbf98b7a1346465d1b717636bdb9074605 100644 (file)
--- a/src/gdcmSerieHelper.h
+++ b/src/gdcmSerieHelper.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmSerieHelper.h,v $
   Language:  C++
-  Date:      $Date: 2005/10/19 13:17:05 $
-  Version:   $Revision: 1.24 $
+  Date:      $Date: 2005/10/23 15:04:26 $
+  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
@@ -30,23 +30,26 @@
 namespace gdcm 
 {
 class File;
-typedef std::vector<File* > FileList;
-   /// XCoherent stands for 'Extra Coherent', 
-   /// (The name 'Coherent' would be enough but it was used before;
-   /// I don't want to put a bomb in the code)
-   /// Any 'better name' is welcome !
-typedef std::map<std::string, FileList *> XCoherentFileSetmap;
+
+
+   typedef std::vector<File* > FileList;
    
-typedef bool (*BOOL_FUNCTION_PFILE_PFILE_POINTER)(File *, File *);
+   /// \brief XCoherent stands for 'Extra Coherent', 
+   ///        (The name 'Coherent' would be enough but it was used before;
+   ///        I don't want to put a bomb in the code)
+   ///        Any 'better name' is welcome !
+   typedef std::map<std::string, FileList *> XCoherentFileSetmap; 
+      
+   typedef bool (*BOOL_FUNCTION_PFILE_PFILE_POINTER)(File *, File *);
 
 //-----------------------------------------------------------------------------
 /**
  * \brief  
  * - This class should be used for a stack of 2D dicom images.
  *   It allows to explore (recursively or not) a directory and 
- *   makes a set of 'Coherent Files' lists (coherent : same SerieUID)
+ *   makes a set of 'Single SerieUID Filesets' 
  *   It allows :
- *   - to sort any of the Coherent File list on the image position.
+ *   - to sort any of the 'Single SerieUID Fileset' on the image position.
  *   - to split any of the Single SerieUID Filesets (better use this name than
  *   'Coherent File List' : it's NOT a std::list, files are NOT coherent ...)
  *    into several XCoherent Filesets 
@@ -55,13 +58,14 @@ typedef bool (*BOOL_FUNCTION_PFILE_PFILE_POINTER)(File *, File *);
 class GDCM_EXPORT SerieHelper 
 {
 public:
-   // SingleSerieUIDFileSetmap replaces the former CoherentFileListmap
-   // ( List were actually std::vectors, and wher no coherent at all :
-   //   They were only Single SeriesInstanceUID File sets)
+   /// SingleSerieUIDFileSetmap replaces the former CoherentFileListmap
+   /// ( List were actually std::vectors, and wher no coherent at all :
+   ///   They were only Single SeriesInstanceUID File sets)
    typedef std::map<std::string, FileList *> SingleSerieUIDFileSetmap;
 
    typedef std::vector<File* > FileVector;
-   
+
+  
    SerieHelper();
    ~SerieHelper();
    void Print(std::ostream &os = std::cout, std::string const &indent = "" );
@@ -119,7 +123,7 @@ public:
    XCoherentFileSetmap SplitOnOrientation(FileList *fileSet); 
    XCoherentFileSetmap SplitOnPosition(FileList *fileSet); 
    XCoherentFileSetmap SplitOnTagValue(FileList *fileSet,
-                                                 uint16_t group, uint16_t element);
+                                               uint16_t group, uint16_t elem);
 private:
    void ClearAll();
    bool UserOrdering(FileList *fileSet);