Some cleaning

[bbtk.git] / kernel / appli / bbCreateBlackBox / xml-templates / VTK_ImageAlgorithm-template.xml

diff --git a/kernel/appli/bbCreateBlackBox/xml-templates/VTK_ImageAlgorithm-template.xml b/kernel/appli/bbCreateBlackBox/xml-templates/VTK_ImageAlgorithm-template.xml
index 3f0f0eccbe4297ae58a561be635b644b308e065b..bf2eea9644ac7cee52e5cd950af5b4476d16c244 100644 (file)
--- a/kernel/appli/bbCreateBlackBox/xml-templates/VTK_ImageAlgorithm-template.xml
+++ b/kernel/appli/bbCreateBlackBox/xml-templates/VTK_ImageAlgorithm-template.xml
@@ -1,19 +1,66 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
+<!--==========================================================================
+   STARTS THE DESCRIPTION OF THE BLACK BOX -->
 
 <blackbox name="__BLACKBOXNAME__" type="VTK_ImageAlgorithm">
 
+ <!--========================================================================
+    THE BOX DOCUMENTATION -->
+
 <author>__AUTHOR__</author>
 <description><PRE>__DESCRIPTION__</PRE></description>
 <category>__CategoryBlackBox__</category>
 
+<!--========================================================================
+    #include directives to be put in the .h generated
+    There must be one tag per file to include -->
+
 <include>vtkImageAnisotropicDiffusion3D.h</include> 
-<include>vtkImageData.h</include> 
+<include>vtkImageData.h                  </include> 
+
+  <!--========================================================================
+    THE vtk class the box inherits from (if any) -->
 <vtkparent>vtkImageAnisotropicDiffusion3D</vtkparent>
 
+ <!--========================================================================
+    INPUTS/OUTPUTS DECLARATION -->
+
 <input name="In" type="vtkImageData*" special="vtk input" description="Input image"/>
 <output name="Out" type="vtkImageData*" special="vtk output" description="Output image"/>
 <input name="DiffusionThreshold" type="double" special="vtk parameter" description="Difference threshold that stops diffusion"/>
 
-</blackbox>
+  <!--========================================================================
+    CONSTRUCTORS / DESTRUCTORS (OPTIONAL) 
+    THE CONSTRUCTION METHOD BODY :
+    Generaly you initialize the Input variables with their default values
+    This is also where you should allocate the output pointers -->
+
+  <constructor>
+  <PRE>
+    bbSetInputIn(0);
+  </PRE>
+  </constructor>
 
+  <!-- THE COPY-CONSTRUCTION METHOD BODY :
+    Here does nothing 
+    But this is where you should allocate the output pointers if any
+    and copy the pointed values (to avoid bug caused by multiple references)-->
+  <copyconstructor>
+  <PRE>
+  </PRE>
+  </copyconstructor>
+
+  <!-- THE DESTRUCTION METHOD BODY :
+    Here does nothing 
+    but this is where you should desallocate the output pointers if any -->
+
+  <destructor>
+  <PRE>
+
+  </PRE>
+  </destructor>
+
+<!--=======================================================================-->
+<!-- END OF BLACK BOX DESCRIPTION -->
+</blackbox>