STYLE: Documentation enhancements/clarifications.

Common/vtkParametricBoy.h

@@ -16,7 +16,7 @@
 // .SECTION Description
 // vtkParametricBoy generates Boy's surface.
 // This is a Model of the projective plane without singularities.
-// It was found  by Werner Boy on assignment from David Hilbert.
+// It was found by Werner Boy on assignment from David Hilbert.
 // .SECTION Thanks
 // Andrew Maclean a.maclean@cas.edu.au for 
 // creating and contributing the class.
@@ -110,9 +110,9 @@ public:
   // Description:
   // Calculate a user defined scalar using one or all of uvw,Pt,Duvw.
   //
-  // u,v are the parameters with Pt being the the cartesian point, 
-  // Du, Dv are the derivatives of this point with respect to u and v.
-  // Pt, Du, Dv are obtained from fn().
+  // uvw are the parameters with Pt being the the cartesian point, 
+  // Duvw are the derivatives of this point with respect to u, v and w.
+  // Pt, Duvw are obtained from Evaluate().
   //
   // This function is only called if the ScalarMode has the value
   // vtkParametricTriangulator::FunctionDefined

Common/vtkParametricConicSpiral.h

@@ -33,9 +33,13 @@ public:
   
   // Description:
   // Construct a conic spiral surface with the following parameters: 
-  // MinimumU = 0, MaximumU = 2Pi, MinimumV = 0, MaximumV = 2Pi, JoinU = 0, 
-  // JoinV = 0, TwistU = 0, TwistV = 0; ClockwiseOrdering = 1, 
-  // DerivativesAvailable = 1, A = 0.2, B = 1.0, C = 0.1, N = 2.
+  // MinimumU = 0, MaximumU = 2Pi, 
+  // MinimumV = 0, MaximumV = 2Pi, 
+  // JoinU = 0, JoinV = 0, 
+  // TwistU = 0, TwistV = 0, 
+  // ClockwiseOrdering = 1, 
+  // DerivativesAvailable = 1, 
+  // A = 0.2, B = 1.0, C = 0.1, N = 2.
   static vtkParametricConicSpiral *New();
 
   // Description
@@ -98,9 +102,9 @@ public:
   // Description:
   // Calculate a user defined scalar using one or all of uvw,Pt,Duvw.
   //
-  // u,v are the parameters with Pt being the the cartesian point, 
-  // Du, Dv are the derivatives of this point with respect to u and v.
-  // Pt, Du, Dv are obtained from Evaluate().
+  // uvw are the parameters with Pt being the the cartesian point, 
+  // Duvw are the derivatives of this point with respect to u, v and w.
+  // Pt, Duvw are obtained from Evaluate().
   //
   // This function is only called if the ScalarMode has the value
   // vtkParametricFunctionSource::FunctionDefined.

Common/vtkParametricFigure8Klein.h

@@ -42,9 +42,13 @@ public:
   
   // Description:
   // Construct a figure-8 Klein Bottle with the following parameters:
-  // MinimumU = -Pi, MaximumU = Pi, MinimumV = -Pi, MaximumV = Pi, JoinU = 1,
-  // JoinV = 1, TwistU = 0, TwistV = 0; Ordering = 1, DerivativesSupplied =
-  // 1, Radius = 1
+  // MinimumU = -Pi, MaximumU = Pi, 
+  // MinimumV = -Pi, MaximumV = Pi, 
+  // JoinU = 1, JoinV = 1, 
+  // TwistU = 0, TwistV = 0,
+  // ClockwiseOrdering = 1, 
+  // DerivativesAvailable = 1, 
+  // Radius = 1
   static vtkParametricFigure8Klein *New();
 
   // Description:
@@ -97,9 +101,9 @@ public:
   // Description:
   // Calculate a user defined scalar using one or all of uvw,Pt,Duvw.
   //
-  // u,v are the parameters with Pt being the the cartesian point, 
-  // Du, Dv are the derivatives of this point with respect to u and v.
-  // Pt, Du, Dv are obtained from fn().
+  // uvw are the parameters with Pt being the the cartesian point, 
+  // Duvw are the derivatives of this point with respect to u, v and w.
+  // Pt, Duvw are obtained from Evaluate().
   //
   // This function is only called if the ScalarMode has the value
   // vtkParametricTriangulator::userDefined

Common/vtkParametricFunction.h

@@ -62,7 +62,7 @@ public:
   // Return the dimension of parametric space. Depending on the dimension,
   // then the (u,v,w) parameters and associated information (e.g., derivates)
   // have meaning. For example, if the dimension of the function is one, then
-  // u[0] and Du[0...2] have meaning.
+  // u[0] and Duvw[0...2] have meaning.
   virtual int GetDimension() = 0;
 
   // Description:
@@ -70,9 +70,12 @@ public:
   // This is a pure virtual function that must be instantiated in 
   // a derived class. 
   //
-  // uvw are the parameters with Pt the returned Cartesian point, Duvw are the
-  // derivatives of this point with respect to u, v and w.  Note that the first three
-  // values in Du are Du, the next three are Dv, and the final three are Dw.
+  // uvw are the parameters, with u corresponding to uvw[0],
+// v to uvw[1] and w to uvw[2] respectively. Pt is the returned Cartesian point, 
+// Duvw are the derivatives of this point with respect to u, v and w.  
+// Note that the first three values in Duvw are Du, the next three are Dv, 
+// and the final three are Dw. Du Dv Dw are the partial derivatives of the 
+// function at the point Pt with respect to u, v and w respectively.
   virtual void Evaluate(double uvw[3], double Pt[3], double Duvw[9]) = 0;
 
   // Description:
@@ -82,7 +85,7 @@ public:
   //
   // uvw are the parameters with Pt being the the cartesian point, 
   // Duvw are the derivatives of this point with respect to u, v, and w.
-  // Pt, Du are obtained from Evaluate().
+  // Pt, Duvw are obtained from Evaluate().
   virtual double EvaluateScalar(double uvw[3], double Pt[3], double Duvw[9]) = 0;
 
   // Description:

Common/vtkParametricKlein.h

@@ -41,9 +41,12 @@ public:
   
   // Description:
   // Construct a Klein Bottle with the following parameters:
-  // MinimumU = 0, MaximumU = 2*Pi+2*Pi/PointsU,
-  // MinimumV = -Pi, MaximumV = Pi, JoinU = 0, JoinV = 1,
-  // TwistU = 0, TwistV = 0; Ordering = 1, DerivativesSupplied = 1,
+  // MinimumU = 0, MaximumU = 2*Pi,
+  // MinimumV = -Pi, MaximumV = Pi, 
+  // JoinU = 0, JoinV = 1,
+  // TwistU = 0, TwistV = 0,
+  // ClockwiseOrdering = 1, 
+  // DerivativesAvailable = 1,
   static vtkParametricKlein *New();  //! Initialise the parameters for the Klein bottle
   
   // Description
@@ -115,9 +118,9 @@ public:
   // Description:
   // Calculate a user defined scalar using one or all of uvw,Pt,Duvw.
   //
-  // u[3] are the parameters with Pt being the the cartesian point, 
-  // Du[9] are the derivatives of this point with respect to u and v.
-  // Pt, Du are obtained from Evaluate().
+  // uvw are the parameters with Pt being the the cartesian point, 
+  // Duvw are the derivatives of this point with respect to u, v and w.
+  // Pt, Duvw are obtained from Evaluate().
   //
   // This function is only called if the ScalarMode has the value
   // vtkParametricTriangulator::userDefined

Common/vtkParametricMobius.h

@@ -33,9 +33,12 @@ public:
   
   // Description:
   // Construct a Mobius strip with the following parameters:
-  // MinimumU = 0, MaximumU = 2*Pi+2*Pi/PointsU,
-  // MinimumV = -1, MaximumV = 1, JoinU = 1, JoinV = 0,
-  // TwistU = 0, TwistV = 0; Ordering = 1, DerivativesSupplied = 1,
+  // MinimumU = 0, MaximumU = 2*Pi,
+  // MinimumV = -1, MaximumV = 1, 
+  // JoinU = 1, JoinV = 0,
+  // TwistU = 0, TwistV = 0,
+  // ClockwiseOrdering = 1, 
+  // DerivativesAvailable = 1,
   // Radius = 1.
   static vtkParametricMobius *New();
 
@@ -82,9 +85,9 @@ public:
   // Description:
   // Calculate a user defined scalar using one or all of uvw,Pt,Duvw.
   //
-  // u,v are the parameters with Pt being the the cartesian point, 
-  // Du, Dv are the derivatives of this point with respect to u and v.
-  // Pt, Du, Dv are obtained from fn().
+  // uvw are the parameters with Pt being the the cartesian point, 
+  // Duvw are the derivatives of this point with respect to u, v and w.
+  // Pt, Du, Dv are obtained from Evaluate().
   //
   // This function is only called if the ScalarMode has the value
   // vtkParametricFunction::userDefined

Common/vtkParametricSuperEllipsoid.h

@@ -41,10 +41,14 @@ public:
   void PrintSelf(ostream& os, vtkIndent indent);
   
   // Description:
-  // Construct a superellipsoid with the following parameters: PointsU = 50,
-  // PointsV = 50, MinimumU = 0, MaximumU = 2*Pi, MinimumV = 0, MaximumV =
-  // 2*Pi, JoinU = 1, JoinV = 1, TwistU = 0, TwistV = 0; Ordering = 0,
-  // DerivativesSupplied = 0, N1 = 1, N2 = 1, XRadius = 1, YRadius = 1,
+  // Construct a superellipsoid with the following parameters:
+  // MinimumU = 0, MaximumU = 2*Pi, 
+  // MinimumV = 0, MaximumV = 2*Pi, 
+  // JoinU = 1, JoinV = 1, 
+  // TwistU = 0, TwistV = 0, 
+  // ClockwiseOrdering = 0,
+  // DerivativesAvailable = 0, 
+  // N1 = 1, N2 = 1, XRadius = 1, YRadius = 1,
   // ZRadius = 1, a sphere in this case.
   static vtkParametricSuperEllipsoid *New();
 
@@ -201,9 +205,9 @@ public:
   // Description:
   // Calculate a user defined scalar using one or all of uvw,Pt,Duvw.
   //
-  // u,v are the parameters with Pt being the the cartesian point, 
-  // Du, Dv are the derivatives of this point with respect to u and v.
-  // Pt, Du, Dv are obtained from fn().
+  // uvw are the parameters with Pt being the the cartesian point, 
+  // Duvw are the derivatives of this point with respect to u, v and w.
+  // Pt, Duvw are obtained from Evaluate().
   //
   // This function is only called if the ScalarMode has the value
   // vtkParametricFunction::userDefined

Common/vtkParametricSuperToroid.h

@@ -45,10 +45,15 @@ public:
   void PrintSelf(ostream& os, vtkIndent indent);
   
   // Description:
-  // Construct a supertoroid with the following parameters: MinimumU = 0,
-  // MaximumU = 2*Pi, MinimumV = 0, MaximumV = 2*Pi, JoinU = 1, JoinV = 1,
-  // TwistU = 0, TwistV = 0; Ordering = 1, DerivativesSupplied = 0,
-  // RingRadius = 1, CrossSectionRadius = 0.5, N1 = 1, N2 = 1, XRadius = 1,
+  // Construct a supertoroid with the following parameters: 
+  // MinimumU = 0, MaximumU = 2*Pi, 
+  // MinimumV = 0, MaximumV = 2*Pi, 
+  // JoinU = 1, JoinV = 1,
+  // TwistU = 0, TwistV = 0, 
+  // ClockwiseOrdering = 1, 
+  // DerivativesAvailable = 0,
+  // RingRadius = 1, CrossSectionRadius = 0.5, 
+  // N1 = 1, N2 = 1, XRadius = 1,
   // YRadius = 1, ZRadius = 1, a torus in this case.
   static vtkParametricSuperToroid *New();
 
@@ -144,9 +149,9 @@ public:
   // Description:
   // Calculate a user defined scalar using one or all of uvw,Pt,Duvw.
   //
-  // u,v are the parameters with Pt being the the cartesian point, Du, Dv are
-  // the derivatives of this point with respect to u and v.  Pt, Du, Dv are
-  // obtained from fn().
+  // uvw are the parameters with Pt being the the cartesian point, 
+  // Duvw are the derivatives of this point with respect to u, v and w.
+  // Pt, Duvw are obtained from Evaluate().
   //
   // This function is only called if the ScalarMode has the value
   // vtkParametricFunction::userDefined

Common/vtkParametricTorus.h

@@ -35,9 +35,12 @@ public:
   
   // Description:
   // Construct a torus with the following parameters:
-  // PointsU = 50, PointsV = 50, MinimumU = 0, MaximumU = 2*Pi,
-  // MinimumV = 0, MaximumV = 2*Pi, JoinU = 1, JoinV = 1,
-  // TwistU = 0, TwistV = 0; Ordering = 1, DerivativesSupplied = 1,
+  // MinimumU = 0, MaximumU = 2*Pi,
+  // MinimumV = 0, MaximumV = 2*Pi, 
+  // JoinU = 1, JoinV = 1,
+  // TwistU = 0, TwistV = 0, 
+  // ClockwiseOrdering = 1, 
+  // DerivativesAvailable = 1,
   // RingRadius = 1, CrossSectionRadius = 0.5.
   static vtkParametricTorus *New();
 
@@ -97,9 +100,9 @@ public:
   // Description:
   // Calculate a user defined scalar using one or all of uvw,Pt,Duvw.
   //
-  // u[3] are the parameters with Pt being the the Cartesian point, 
-  // Du[9] are the derivatives of this point with respect to u and v.
-  // Pt, Du are obtained from Evaluate().
+  // uvw are the parameters with Pt being the the Cartesian point, 
+  // Duvw are the derivatives of this point with respect to u, v and w.
+  // Pt, Duvw are obtained from Evaluate().
   //
   // This function is only called if the ScalarMode has the value
   // vtkParametricFunctionSource::SCALAR_FUNCTION_DEFINED