X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;ds=sidebyside;f=src%2FgdcmDirList.h;h=4e112d07b5931a8ca16f03d967f4df7e7dc568d7;hb=e37def13c113c838f969f2dc37b5b7ce4c0c2483;hp=5fa55a2bdbe066bf4a84633bf7c8abfe447c6c21;hpb=9b3db5f141ec2b11eadefaa2ea2a3a20058b37f9;p=gdcm.git

diff --git a/src/gdcmDirList.h b/src/gdcmDirList.h
index 5fa55a2b..4e112d07 100644
--- a/src/gdcmDirList.h
+++ b/src/gdcmDirList.h
@@ -1,5 +1,21 @@
-// gdcmDirList.h
-//-----------------------------------------------------------------------------
+/*=========================================================================
+                                                                                
+  Program:   gdcm
+  Module:    $RCSfile: gdcmDirList.h,v $
+  Language:  C++
+  Date:      $Date: 2004/10/16 14:34:12 $
+  Version:   $Revision: 1.12 $
+                                                                                
+  Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
+  l'Image). All rights reserved. See Doc/License.txt or
+  http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
+                                                                                
+     This software is distributed WITHOUT ANY WARRANTY; without even
+     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+     PURPOSE.  See the above copyright notices for more information.
+                                                                                
+=========================================================================*/
+
 #ifndef GDCMDIRLIST_H
 #define GDCMDIRLIST_H
 
@@ -7,25 +23,36 @@
 
 #include <string>
 #include <list>
+namespace gdcm 
+{
 
 //-----------------------------------------------------------------------------
-class GDCM_EXPORT gdcmDirList: public std::list<std::string>
+/**
+ * \ingroup DirList
+ * \brief   List containing the file headers from root directory. 
+ */
+// NOTE: Due to a VC6 'feature' we can not export a std::list in a dll, 
+// so GDCM_EXPORT keyword was removed for this class only
+class DirList: public std::list<std::string>
 {
 public :
-   gdcmDirList(std::string dirName,bool recursive=false);
-   virtual ~gdcmDirList(void);
+   DirList(std::string dirName,bool recursive=false);
+   virtual ~DirList();
 
-   std::string GetDirName(void);
+   std::string GetDirName();
 
+   /// Character '\' 
    static const char SEPARATOR_X;
+   /// Character '/'  
    static const char SEPARATOR_WIN;
+   /// depending on the O.S.
    static const std::string SEPARATOR;
 
 private :
-   void Explore(std::string dirName,bool recursive=false);
-
+   int Explore(std::string dirName,bool recursive=false);
+   /// name of the root directory to explore
    std::string name;
 };
-
+} // end namespace gdcm
 //-----------------------------------------------------------------------------
 #endif