ENH: Added documentation.

include/CleanP.hh

@@ -6,8 +6,6 @@
   Date:      $Date$
   Version:   $Revision$
 
-Description:
----------------------------------------------------------------------------
 This file is part of the Visualization Library. No part of this file
 or its contents may be copied, reproduced or altered in any way
 without the express written consent of the authors.
@@ -15,11 +13,17 @@ without the express written consent of the authors.
 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen 1993, 1994 
 
 =========================================================================*/
-//
-// Merges duplicate points and transforms degenerate topology into 
-// appropriate form (for example, triangle into line is two points 
-// are merged)
-//
+// .NAME vlCleanPolyData - merge duplicate points and remove degenerate primitives
+// .SECTION Description
+// vlCleanPolyData is a filter that takes as input vlPolyData and 
+// generates vlPolyData as output. vlCleanPolyData merges duplicate 
+// points (within specified tolerance) and transforms degenerate 
+// topology into appropriate form (for example, triangle is converted
+// into line if two points of triangle are merged).
+// .SECTION Caveats
+// Merging points can alter topology including introducing non-manifold 
+// forms. Tolerance should be chosen carefully to avoid these problems.
+
 #ifndef __vlCleanPolyData_h
 #define __vlCleanPolyData_h
 
@@ -33,9 +37,14 @@ public:
   char *GetClassName() {return "vlCleanPolyData";};
   void PrintSelf(ostream& os, vlIndent indent);
 
+  // Description:
+  // Specify tolerance in terms of percentage of bounding box.
   vlSetClampMacro(Tolerance,float,0.0,1.0); //% of bounding box
   vlGetMacro(Tolerance,float);
 
+  // Description:
+  // Specify a spatial locator for speeding the search process. By
+  // default an instance of vlLocator is used.
   vlSetObjectMacro(Locator,vlLocator);
   vlGetObjectMacro(Locator,vlLocator);
 

include/ContourF.hh

@@ -13,9 +13,21 @@ written consent of the authors.
 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen 1993, 1994 
 
 =========================================================================*/
-//
-// Contours arbitrary input
-//
+// .NAME vlContourFilter - generate iso-surfaces/iso-lines from scalar values
+// .SECTION Description
+// vlContourFilter is a filter that takes as input any data set and generates
+// on output iso-surfaces and/or iso-lines. The exact form of the output 
+// depends upon the dimensionality of the input data. Data consisting of 
+// 3D cells will generate iso-surfaces, data consisting of 2D cells will 
+// generate iso-lines, and data with 1D or 0D cells will generate 
+// iso-points. Combinations of output type is possible if the input 
+// dimension is mixed.
+// .SECTION Caveats
+// vlContourFilter uses variations of marching cubes to generate output
+// primitives. The output primitives are disjoint - that is, points may
+// be generated that are coincident but distinct. Use vlCleanPolyData to
+// merge coincident points.
+
 #ifndef __vlContourFilter_h
 #define __vlContourFilter_h
 
@@ -32,6 +44,9 @@ public:
   void PrintSelf(ostream& os, vlIndent indent);
 
   void SetValue(int i, float value);
+
+  // Description:
+  // Return pointer to array of contour values (size of numContours).
   vlGetVectorMacro(Values,float);
 
   void GenerateValues(int numContours, float range[2]);

include/OutlineF.hh

@@ -6,8 +6,6 @@
   Date:      $Date$
   Version:   $Revision$
 
-Description:
----------------------------------------------------------------------------
 This file is part of the Visualization Library. No part of this file
 or its contents may be copied, reproduced or altered in any way
 without the express written consent of the authors.
@@ -15,9 +13,11 @@ without the express written consent of the authors.
 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen 1993, 1994 
 
 =========================================================================*/
-//
-// Outlines arbitrary input
-//
+// .NAME vlOutlineFilter - create wireframe outline for arbitrary data set
+// .SECTION Description
+// vlOutlineFilter is a filter that generates a wireframe outline of any 
+// data set. The outline consists of the twelve edges of the bounding box.
+
 #ifndef __vlOutlineFilter_h
 #define __vlOutlineFilter_h
 

include/ShrinkF.hh

@@ -37,10 +37,10 @@ public:
   char *GetClassName() {return "vlShrinkFilter";};
   void PrintSelf(ostream& os, vlIndent indent);
 
-  // Description:
+  // Macro Description:
   // Set the fraction of shrink for each cell.
   vlSetClampMacro(ShrinkFactor,float,0.0,1.0);
-  // Description:
+  // Macro Description:
   // Get the fraction of shrink for each cell.
   vlGetMacro(ShrinkFactor,float);
 

include/WarpVect.hh

@@ -6,8 +6,6 @@
   Date:      $Date$
   Version:   $Revision$
 
-Description:
----------------------------------------------------------------------------
 This file is part of the Visualization Library. No part of this file
 or its contents may be copied, reproduced or altered in any way
 without the express written consent of the authors.
@@ -34,6 +32,8 @@ public:
   char *GetClassName() {return "vlWarpVector";};
   void PrintSelf(ostream& os, vlIndent indent);
 
+  // Description:
+  // Specify value to scale displacement.
   vlSetMacro(ScaleFactor,float);
   vlGetMacro(ScaleFactor,float);
 

src/CleanP.cc

@@ -6,8 +6,6 @@
   Date:      $Date$
   Version:   $Revision$
 
-Description:
----------------------------------------------------------------------------
 This file is part of the Visualization Library. No part of this file
 or its contents may be copied, reproduced or altered in any way
 without the express written consent of the authors.
@@ -17,6 +15,8 @@ Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen 1993, 1994
 =========================================================================*/
 #include "CleanP.hh"
 
+// Description:
+// Construct object with initial tolerance of 0.0.
 vlCleanPolyData::vlCleanPolyData()
 {
   this->Tolerance = 0.0;

src/ContourF.cc

@@ -17,6 +17,9 @@ Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen 1993, 1994
 #include "FScalars.hh"
 #include "Cell.hh"
 
+// Description:
+// Construct object with initial range (0,1) and single contour value
+// of 0.0.
 vlContourFilter::vlContourFilter()
 {
   for (int i=0; i<MAX_CONTOURS; i++) this->Values[i] = 0.0;
@@ -25,6 +28,8 @@ vlContourFilter::vlContourFilter()
   this->Range[1] = 1.0;
 }
 
+// Description:
+// Set a particular contour value at contour number i.
 void vlContourFilter::SetValue(int i, float value)
 {
   i = (i >= MAX_CONTOURS ? MAX_CONTOURS-1 : (i < 0 ? 0 : i) );
@@ -38,6 +43,9 @@ void vlContourFilter::SetValue(int i, float value)
     }
 }
 
+// Description:
+// Generate numContours equally spaced contour values between specified
+// range.
 void vlContourFilter::GenerateValues(int numContours, float range[2])
 {
   float val, incr;

src/OutlineF.cc

@@ -6,8 +6,6 @@
   Date:      $Date$
   Version:   $Revision$
 
-Description:
----------------------------------------------------------------------------
 This file is part of the Visualization Library. No part of this file
 or its contents may be copied, reproduced or altered in any way
 without the express written consent of the authors.