Removal of useless and dangerous methods :

[gdcm.git] / src / gdcmDirList.h

diff --git a/src/gdcmDirList.h b/src/gdcmDirList.h
index e9cf3c5583bdf142a9a77aa9febb77fe0ffed0df..2685ca37d7d20bb767fd687184a264eecd3afc7e 100644 (file)
--- 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: 2005/01/06 20:03:27 $
+  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
+  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
 
@@ -8,25 +24,38 @@
 #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 const &dirName, bool recursive=false);
+   virtual ~DirList();
 
-   std::string GetDirName(void);
+   std::string const &GetDirName() const;
 
+   /// Character '\' 
    static const char SEPARATOR_X;
+   /// Character '/'  
    static const char SEPARATOR_WIN;
+   /// depending on the O.S.
    static const std::string SEPARATOR;
 
 private :
-   void NormalizePath(std::string &dirName);
-   void Explore(std::string dirName,bool recursive=false);
+   int Explore(std::string const &dirName, bool recursive=false);
 
+   /// name of the root directory to explore
    std::string name;
 };
-
+} // end namespace gdcm
 //-----------------------------------------------------------------------------
 #endif