Some cleaning

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

diff --git a/kernel/appli/bbCreateBlackBox/xml-templates/VTK_PolyDataAlgorithm-template.xml b/kernel/appli/bbCreateBlackBox/xml-templates/VTK_PolyDataAlgorithm-template.xml
index b6eca380de057af593c2c50bef74e799c915a70e..c7f15bcac32ca0ec9ff1a3cfc3e2da7a76e8371c 100644 (file)
--- a/kernel/appli/bbCreateBlackBox/xml-templates/VTK_PolyDataAlgorithm-template.xml
+++ b/kernel/appli/bbCreateBlackBox/xml-templates/VTK_PolyDataAlgorithm-template.xml
@@ -1,15 +1,27 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-
-
+<!--==========================================================================
+   STARTS THE DESCRIPTION OF THE BLACK BOX -->
 <blackbox name="__BLACKBOXNAME__" type="VTK_PolyDataAlgorithm">
 
+ <!--========================================================================
+    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>vtkAppendPolyData.h</include> 
+
+  <!--========================================================================
+    THE vtk class the box inherits from (if any) -->
 <vtkparent>vtkAppendPolyData</vtkparent>
 
+ <!--========================================================================
+    INPUTS/OUTPUTS DECLARATION -->
 <output name="Out" type="vtkPolyData*" special="vtk output" description="Output Mesh"/>
 <input name="In1" type="vtkPolyData *" description="PolyData 1"/>
 <input name="In2" type="vtkPolyData *" description="PolyData 2"/>
@@ -17,6 +29,9 @@
 <input name="In4" type="vtkPolyData *" description="PolyData 4"/>
 <input name="In5" type="vtkPolyData *" description="PolyData 5"/>
 
+ <!--========================================================================
+    PROCESS section -->
+
 <process>
 <PRE>
   SetInput(bbGetInputIn1());
@@ -24,11 +39,17 @@
   SetInput(bbGetInputIn3());
   SetInput(bbGetInputIn4());
   SetInput(bbGetInputIn5());
-   
+
   Update();
 </PRE>
 </process>
 
+  <!--========================================================================
+    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>
   bbSetInputIn1((vtkPolyData *)0);
@@ -38,9 +59,29 @@
   bbSetInputIn5((vtkPolyData *)0);
   bbSetOutputOut((vtkPolyData *)0);
 </PRE>
-</constructor>   
+</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>