move directory

[creaImageIO.git] / src2 / creaImageIOAbstractImageReader.h

diff --git a/src2/creaImageIOAbstractImageReader.h b/src2/creaImageIOAbstractImageReader.h
index 3d8ac24b6807fe43256ff38ba89c470015177e6b..3957f3a7d652456127bcbf461fea6d38cc9f8a7e 100644 (file)
--- a/src2/creaImageIOAbstractImageReader.h
+++ b/src2/creaImageIOAbstractImageReader.h
@@ -6,14 +6,14 @@
 #include <string>
 #include <map>
 #include <vector>
-#include <creaImageIOTreeAttributeMapType.h>
+#include "creaImageIOTreeAttributeMapType.h"
 
 namespace creaImageIO
 {
 
 
   /**
-   * \ingroup ReadWrite
+   * \ingroup IO
    */
   
   //=====================================================================
@@ -24,14 +24,25 @@ namespace creaImageIO
     AbstractImageReader() {}
     virtual ~AbstractImageReader() {}
 
+       /// Get the reader's name
     const std::string& GetName() const { return mName; }
+
+       /// Add file extensions read by the reader
     virtual void PushBackExtensions(std::vector<std::string>&) {}
+
+       /// Test if file is read by this reader
     virtual bool CanRead(const std::string& filename) { return false; }
-    virtual vtkImageData* ReadImage(const std::string& filename) { return 0; }
+
+       /// return for a file a 2D VTkImage
+    virtual vtkImageData* ReadImage(const std::string& filename) { return 0; } 
+
+       /// Read the attributes for a file
     virtual void ReadAttributes(const std::string& filename, 
                                tree::AttributeMapType& attr) {}
 
   protected:
+
+    /// Set the reader's name
     void SetName(const std::string& s) { mName = s; }
   private:
     std::string mName;