DOC

Code/IO/otbMapFileProductWriter.h

@@ -44,9 +44,9 @@ namespace otb
  *        on the disk.
  *       
  * This filter begins by tiling the input image. An accessor
- * SetTileSize allows to set the tiles size. For each tile generated,
- * an entry is added to the shapefile to store the location where the
- * file is saved on the disk.
+ * SetTileSize allows to set the size of each tile. For each tile
+ * generated, an entry is added to the shapefile to store the location
+ * where the file is saved on the disk.
  * The product generated are a mapfile wich is the configuration file
  * for mapservers, a tile index and finally the tiles.
  *
@@ -117,12 +117,14 @@ public:
   const InputImageType * GetInput(void);
   const InputImageType * GetInput(unsigned int idx);
 
-  // Accessors macros
+  /** Method to set the filename of the mapfile generated */
   itkSetStringMacro(FileName);
+  
+  /** Set/Get the size of each tile*/
   itkSetMacro(TileSize,unsigned int);
   itkGetMacro(TileSize,unsigned int);
   
-  /** Update Method */
+  /** Update Method : Call a porotected Write method */
   virtual void Update()
   {
     this->Write();

Code/IO/otbMapFileProductWriter.txx

@@ -23,6 +23,10 @@
 
 namespace otb
 {
+
+/** 
+ * Constructor
+ */
 template <class TInputImage>
 MapFileProductWriter<TInputImage>
 ::MapFileProductWriter():  m_UseExtendMode(true), m_TileSize(256)
@@ -31,6 +35,10 @@ MapFileProductWriter<TInputImage>
   this->SetNumberOfRequiredInputs(1);
 }
 
+
+/** 
+ * Desctructor
+ */
 template <class TInputImage>
 MapFileProductWriter<TInputImage>
 ::~MapFileProductWriter()
@@ -79,7 +87,7 @@ MapFileProductWriter<TInputImage>
 }
   
 /**
- *
+ *  Get the idx input
  */
 template <class TInputImage>
 const typename MapFileProductWriter<TInputImage>::InputImageType *
@@ -90,6 +98,11 @@ MapFileProductWriter<TInputImage>
     (this->ProcessObject::GetInput(idx));
 }
 
+
+/**
+ * Write lauch the tiling and the mapFile generation and write on the
+ * disk the indexfile as a shapefile
+ */
 template <class TInputImage>
 void
 MapFileProductWriter<TInputImage>
@@ -115,7 +128,10 @@ MapFileProductWriter<TInputImage>
   writer->Update();
 }
 
-
+/**
+ * Initialize the path, the filename, the vectordata used to store
+ * each bounding box of a tile as a feature
+ */
 template <class TInputImage>
 void
 MapFileProductWriter<TInputImage>
@@ -155,7 +171,9 @@ MapFileProductWriter<TInputImage>
   m_VectorDataIndexTile->GetDataTree()->Add(m_Folder, document);
 }
 
-
+/**
+ *  Do the tiling 
+ */
 template <class TInputImage>
 void
 MapFileProductWriter<TInputImage>
@@ -396,8 +414,9 @@ MapFileProductWriter<TInputImage>
 }
 
 /**
-*/
-
+ *  Add the bounding box and the location of the generated tile as
+ *  field of the vectordata
+ */
 template <class TInputImage>
 void
 MapFileProductWriter<TInputImage>
@@ -448,6 +467,7 @@ MapFileProductWriter<TInputImage>
 }
 
 /**
+ * Write the mapFile on the disk
  */
 template <class TInputImage>
 void