* Test/TestAllEntryVerify.cxx minor fix and added comments.

[gdcm.git] / src / gdcmDirList.h

diff --git a/src/gdcmDirList.h b/src/gdcmDirList.h
index 5fa55a2bdbe066bf4a84633bf7c8abfe447c6c21..c66aa837ae78586d3fb85f0b71d91a990a2964e9 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: 2004/07/26 19:36:56 $
+  Version:   $Revision: 1.8 $
+                                                                                
+  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.htm 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
 
@@ -9,6 +25,10 @@
 #include <list>
 
 //-----------------------------------------------------------------------------
+/**
+ * \ingroup gdcmDirList
+ * \brief   List containing the file headers from root directory. 
+ */
 class GDCM_EXPORT gdcmDirList: public std::list<std::string>
 {
 public :
@@ -17,13 +37,16 @@ public :
 
    std::string GetDirName(void);
 
+   /// 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;
 };