doxygenation

[gdcm.git] / src / gdcmDirList.cxx

diff --git a/src/gdcmDirList.cxx b/src/gdcmDirList.cxx
index f8a2d637963b1ea71e1edda1534ac91a9283a1f8..f49c0ba92c0168caa0fa2b42137ca15558fefaf3 100644 (file)
--- a/src/gdcmDirList.cxx
+++ b/src/gdcmDirList.cxx
@@ -1,6 +1,7 @@
 // gdcmDirList.cxx
 //-----------------------------------------------------------------------------
 #include "gdcmDirList.h"
+#include "gdcmUtil.h"
 
 #include <iostream>
 #include <algorithm>
@@ -20,17 +21,12 @@
    #include <unistd.h>
 #endif
 
-//-----------------------------------------------------------------------------
-const char gdcmDirList::SEPARATOR_X      = '/';
-const char gdcmDirList::SEPARATOR_WIN    = '\\';
-const std::string gdcmDirList::SEPARATOR = "/";
-
-//-----------------------------------------------------------------------------
 // Constructor / Destructor
-/*
+/**
  * \ingroup gdcmDirList
  * \brief Constructor  
- * @param   
+ * @param  dirName root directory name
+ * @param  recursive whether we want to explore recursively or not 
  */
 gdcmDirList::gdcmDirList(std::string dirName,bool recursive)
 {
@@ -40,7 +36,7 @@ gdcmDirList::gdcmDirList(std::string dirName,bool recursive)
    Explore(name,recursive);
 }
 
-/*
+/**
  * \ingroup gdcmDirList
  * \brief  Destructor
  */
@@ -53,10 +49,10 @@ gdcmDirList::~gdcmDirList(void)
 
 //-----------------------------------------------------------------------------
 // Public
-/*
+/**
  * \ingroup gdcmDirList
  * \brief   Get the directory name
- * @param   
+ * @return the directory name 
  */
 std::string gdcmDirList::GetDirName(void)
 {
@@ -68,24 +64,12 @@ std::string gdcmDirList::GetDirName(void)
 
 //-----------------------------------------------------------------------------
 // Private
-/*
- * \ingroup gdcmDirList
- * \brief   Add a SEPARATOR to the end of the directory name is necessary
- * @param   
- */
-void gdcmDirList::NormalizePath(std::string &dirName)
-{
-   int size=dirName.size();
-   if((dirName[size-1]!=SEPARATOR_X)&&(dirName[size-1]!=SEPARATOR_WIN))
-   {
-      dirName+=SEPARATOR;
-   }
-}
 
-/*
+/**
  * \ingroup gdcmDirList
  * \brief   Explore a directory with possibility of recursion
- * @param   
+ * @param  dirName directory to explore
+ * @param  recursive whether we want recursion or not
  */
 void gdcmDirList::Explore(std::string dirName,bool recursive)
 {
@@ -104,7 +88,7 @@ void gdcmDirList::Explore(std::string dirName,bool recursive)
       if(fileData.dwFileAttributes&FILE_ATTRIBUTE_DIRECTORY)
       {
          if( (fileName!=".") && (fileName!="..") && (recursive) )
-            Explore(dirName+fileName);
+            Explore(dirName+fileName,recursive);
       }
       else
       {
@@ -124,7 +108,7 @@ void gdcmDirList::Explore(std::string dirName,bool recursive)
       if(namelist[i]->d_type==DT_DIR)
       {
          if( (fileName!=".") && (fileName!="..") && (recursive) )
-            Explore(dirName+fileName);
+            Explore(dirName+fileName,recursive);
       }
       else
       {