Commit a2250027 authored by David E. DeMarle's avatar David E. DeMarle Committed by David E. DeMarle

preemptively fix issues that trip of doxygen converted code

fix problematic ccomments that trip up doxygen generator. Mostly
c style comments in class description but a few cases of comments
not in expected location that leads to stripped out code and comp fails

fix trailing whitespaces that will fail style check when committed

Thanks Andrew Maclean for updating the url to VTK publications.
parent fe18e42b
Pipeline #27717 passed with stage
......@@ -19,7 +19,7 @@
// It was found by Werner Boy on assignment from David Hilbert.
//
// For further information about this surface, please consult the
// technical description "Parametric surfaces" in http://www.vtk.org/documents.php
// technical description "Parametric surfaces" in http://www.vtk.org/publications
// in the "VTK Technical Documents" section in the VTk.org web pages.
//
// .SECTION Thanks
......@@ -81,7 +81,6 @@ public:
//
// If the user does not need to calculate a scalar, then the
// instantiated function should return zero.
//
double EvaluateScalar(double uvw[3], double Pt[3], double Duvw[9]) VTK_OVERRIDE;
protected:
......
......@@ -18,7 +18,7 @@
// may look like a torus "eating" its own tail.
//
// For further information about this surface, please consult the
// technical description "Parametric surfaces" in http://www.vtk.org/documents.php
// technical description "Parametric surfaces" in http://www.vtk.org/publications
// in the "VTK Technical Documents" section in the VTk.org web pages.
//
// .SECTION Thanks
......
......@@ -19,7 +19,7 @@
// This is one possible image of a projective plane in three-space.
//
// For further information about this surface, please consult the
// technical description "Parametric surfaces" in http://www.vtk.org/documents.php
// technical description "Parametric surfaces" in http://www.vtk.org/publications
// in the "VTK Technical Documents" section in the VTk.org web pages.
//
// .SECTION Thanks
......@@ -74,7 +74,6 @@ public:
//
// If the user does not need to calculate a scalar, then the
// instantiated function should return zero.
//
double EvaluateScalar(double uvw[3], double Pt[3], double Duvw[9]) VTK_OVERRIDE;
protected:
......
......@@ -19,7 +19,7 @@
// Gaussian curvature
//
// For further information about this surface, please consult the
// technical description "Parametric surfaces" in http://www.vtk.org/documents.php
// technical description "Parametric surfaces" in http://www.vtk.org/publications
// in the "VTK Technical Documents" section in the VTk.org web pages.
//
// .SECTION Thanks
......@@ -89,7 +89,6 @@ public:
//
// If the user does not need to calculate a scalar, then the
// instantiated function should return zero.
//
double EvaluateScalar(double uvw[3], double Pt[3], double Duvw[9]) VTK_OVERRIDE;
protected:
......
......@@ -22,7 +22,7 @@
// A prolate spheroid occurs if RadiusX = RadiusY < RadiusZ.
//
// For further information about this surface, please consult the
// technical description "Parametric surfaces" in http://www.vtk.org/documents.php
// technical description "Parametric surfaces" in http://www.vtk.org/publications
// in the "VTK Technical Documents" section in the VTk.org web pages.
//
// .SECTION Thanks
......@@ -93,7 +93,6 @@ public:
//
// If the user does not need to calculate a scalar, then the
// instantiated function should return zero.
//
double EvaluateScalar(double uvw[3], double Pt[3], double Duvw[9]) VTK_OVERRIDE;
protected:
......
......@@ -19,7 +19,7 @@
// possessing constant negative Gaussian curvature
//
// For further information about this surface, please consult the
// technical description "Parametric surfaces" in http://www.vtk.org/documents.php
// technical description "Parametric surfaces" in http://www.vtk.org/publications
// in the "VTK Technical Documents" section in the VTk.org web pages.
//
// .SECTION Thanks
......@@ -74,7 +74,6 @@ public:
//
// If the user does not need to calculate a scalar, then the
// instantiated function should return zero.
//
double EvaluateScalar(double uvw[3], double Pt[3], double Duvw[9]) VTK_OVERRIDE;
protected:
......
......@@ -26,7 +26,7 @@
// "Figure-8 Klein Bottle"
//
// For further information about this surface, please consult the
// technical description "Parametric surfaces" in http://www.vtk.org/documents.php
// technical description "Parametric surfaces" in http://www.vtk.org/publications
// in the "VTK Technical Documents" section in the VTk.org web pages.
//
// .SECTION Thanks
......@@ -86,7 +86,6 @@ public:
//
// If the user does not need to calculate a scalar, then the
// instantiated function should return zero.
//
double EvaluateScalar(double uvw[3], double Pt[3], double Duvw[9]) VTK_OVERRIDE;
protected:
......
......@@ -26,7 +26,7 @@
//
//
// For further information about this surface, please consult the
// technical description "Parametric surfaces" in http://www.vtk.org/documents.php
// technical description "Parametric surfaces" in http://www.vtk.org/publications
// in the "VTK Technical Documents" section in the VTk.org web pages.
//
// .SECTION Thanks
......@@ -80,7 +80,6 @@ public:
//
// If the user does not need to calculate a scalar, then the
// instantiated function should return zero.
//
double EvaluateScalar(double uvw[3], double Pt[3], double Duvw[9]) VTK_OVERRIDE;
protected:
......
......@@ -17,7 +17,7 @@
// vtkParametricMobius generates a Mobius strip.
//
// For further information about this surface, please consult the
// technical description "Parametric surfaces" in http://www.vtk.org/documents.php
// technical description "Parametric surfaces" in http://www.vtk.org/publications
// in the "VTK Technical Documents" section in the VTk.org web pages.
//
// .SECTION Thanks
......@@ -77,7 +77,6 @@ public:
//
// If the user does not need to calculate a scalar, then the
// instantiated function should return zero.
//
double EvaluateScalar(double uvw[3], double Pt[3], double Duvw[9]) VTK_OVERRIDE;
protected:
......
......@@ -21,7 +21,7 @@
// In this case the hills will all have the same shape and height.
//
// For further information about this surface, please consult the
// technical description "Parametric surfaces" in http://www.vtk.org/documents.php
// technical description "Parametric surfaces" in http://www.vtk.org/publications
// in the "VTK Technical Documents" section in the VTk.org web pages.
//
// .SECTION Thanks
......@@ -152,7 +152,6 @@ public:
//
// If the user does not need to calculate a scalar, then the
// instantiated function should return zero.
//
double EvaluateScalar(double uvw[3], double Pt[3], double Duvw[9]) VTK_OVERRIDE;
protected:
......
......@@ -17,7 +17,7 @@
// vtkParametricRoman generates Steiner's Roman Surface.
//
// For further information about this surface, please consult the
// technical description "Parametric surfaces" in http://www.vtk.org/documents.php
// technical description "Parametric surfaces" in http://www.vtk.org/publications
// in the "VTK Technical Documents" section in the VTk.org web pages.
//
// .SECTION Thanks
......@@ -78,7 +78,6 @@ public:
//
// If the user does not need to calculate a scalar, then the
// instantiated function should return zero.
//
double EvaluateScalar(double uvw[3], double Pt[3], double Duvw[9]) VTK_OVERRIDE;
......
......@@ -20,7 +20,7 @@
// cylindrical can.
//
// For further information about this surface, please consult the
// technical description "Parametric surfaces" in http://www.vtk.org/documents.php
// technical description "Parametric surfaces" in http://www.vtk.org/publications
// in the "VTK Technical Documents" section in the VTk.org web pages.
//
// Also see: http://paulbourke.net/geometry/superellipse/
......@@ -107,7 +107,6 @@ public:
//
// If the user does not need to calculate a scalar, then the
// instantiated function should return zero.
//
double EvaluateScalar(double uvw[3], double Pt[3], double Duvw[9]) VTK_OVERRIDE;
protected:
......
......@@ -24,7 +24,7 @@
// basically toroidal in shape.
//
// For further information about this surface, please consult the
// technical description "Parametric surfaces" in http://www.vtk.org/documents.php
// technical description "Parametric surfaces" in http://www.vtk.org/publications
// in the "VTK Technical Documents" section in the VTk.org web pages.
//
// Also see: http://paulbourke.net/geometry/torus/#super.
......@@ -124,7 +124,6 @@ public:
//
// If the user does not need to calculate a scalar, then the
// instantiated function should return zero.
//
double EvaluateScalar(double uvw[3], double Pt[3], double Duvw[9]) VTK_OVERRIDE;
protected:
......
......@@ -17,7 +17,7 @@
// vtkParametricTorus generates a torus.
//
// For further information about this surface, please consult the
// technical description "Parametric surfaces" in http://www.vtk.org/documents.php
// technical description "Parametric surfaces" in http://www.vtk.org/publications
// in the "VTK Technical Documents" section in the VTk.org web pages.
//
// .SECTION Thanks
......@@ -84,7 +84,6 @@ public:
//
// If the user does not need to calculate a scalar, then the
// instantiated function should return zero.
//
double EvaluateScalar(double uvw[3], double Pt[3], double Duvw[9]) VTK_OVERRIDE;
protected:
......
......@@ -35,19 +35,19 @@
// {
// if (it->GetCellType() != VTK_TETRA)
// {
// continue; /* Skip non-tetrahedral cells */
// continue; // Skip non-tetrahedral cells
// }
//
// vtkIdList *pointIds = it->GetPointIds();
// /* Do screening on the point ids, maybe figure out scalar range and skip
// cells that do not lie in a certain range? */
// // Do screening on the point ids, maybe figure out scalar range and skip
// cells that do not lie in a certain range?
//
// vtkPoints *points = it->GetPoints();
// /* Do work using the cell points, or ... */
// // Do work using the cell points, or ...
//
// vtkGenericCell *cell = ...;
// it->GetCell(cell);
// /* ... do work with a vtkCell. */
// // ... do work with a vtkCell.
// }
// it->Delete();
// }
......
......@@ -113,7 +113,6 @@ public:
// Description:
// Default constructor which will create an instance of the DefaultFunctorType
// and use that single instance for all calls.
//
vtkDataArrayDispatcher();
virtual ~vtkDataArrayDispatcher();
......
......@@ -235,7 +235,6 @@ public:
// is vtkDataSetAttributes::PEDIGREEIDS (error indicator)
// - aa has a number of components incompatible with the attribute type
// (error indicator)
//
int SetAttribute(vtkAbstractArray* aa, int attributeType);
// Description:
......
......@@ -126,7 +126,7 @@
// ----------------------------------------------------------------------
// vtkNew<MyGrid> grid;
// grid->GetImplementation()->SetImplementationDetails(...);
// /* grid is now ready to use. */
// // grid is now ready to use.
// @endcode
//
// The vtkCPExodusIIElementBlock class provides an example of
......
......@@ -163,7 +163,6 @@ public:
// vtkReebGraph::ERR_NOT_A_SIMPLICIAL_MESH: the input mesh 'mesh' is not a
// simplicial mesh (for example, the surface mesh contains quads instead of
// triangles).
//
int Build(vtkPolyData *mesh, vtkDataArray *scalarField);
// Description:
......@@ -177,7 +176,6 @@ public:
//
// vtkReebGraph::ERR_NOT_A_SIMPLICIAL_MESH: the input mesh 'mesh' is not a
// simplicial mesh.
//
int Build(vtkUnstructuredGrid *mesh, vtkDataArray *scalarField);
......@@ -196,7 +194,6 @@ public:
//
// vtkReebGraph::ERR_NO_SUCH_FIELD: the scalar field given by the Id
// 'scalarFieldId' does not exist.
//
int Build(vtkPolyData *mesh, vtkIdType scalarFieldId);
// Description:
......@@ -213,7 +210,6 @@ public:
//
// vtkReebGraph::ERR_NO_SUCH_FIELD: the scalar field given by the Id
// 'scalarFieldId' does not exist.
//
int Build(vtkUnstructuredGrid *mesh, vtkIdType scalarFieldId);
......@@ -232,7 +228,6 @@ public:
//
// vtkReebGraph::ERR_NO_SUCH_FIELD: the scalar field given by the name
// 'scalarFieldName' does not exist.
//
int Build(vtkPolyData *mesh, const char* scalarFieldName);
// Description:
......@@ -249,7 +244,6 @@ public:
//
// vtkReebGraph::ERR_NO_SUCH_FIELD: the scalar field given by the name
// 'scalarFieldName' does not exist.
//
int Build(vtkUnstructuredGrid *mesh, const char* scalarFieldName);
// Description:
......
......@@ -22,13 +22,13 @@
// L0 L1 L2
// RR | .R. ... | ...
// For this tree:
/* HTG: . */
/* / \ */
/* L0: . . */
/* /|\ /|\ */
/* L1: c . c c c c */
/* /|\ */
/* L2: c c c */
// HTG: .
// / \
// L0: . .
// /|\ /|\
// L1: c . c c c c
// /|\
// L2: c c c
// The top level of the tree is not considered a grid level
// NB: For ease of legibility, white spaces are allowed and ignored.
//
......
......@@ -200,7 +200,6 @@ private:
// Before using this function, ensure that: UResolution,
// VResolution, MinimumU, MaximumU, MinimumV, MaximumV, JoinU, JoinV,
// TwistU, TwistV, ordering are set appropriately for the parametric function.
//
void MakeTriangles ( vtkCellArray * strips, int PtsU, int PtsV );
vtkParametricFunctionSource(const vtkParametricFunctionSource&) VTK_DELETE_FUNCTION;
......
......@@ -12,18 +12,6 @@
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
#ifndef vtkComputeQuartiles_h
#define vtkComputeQuartiles_h
#include "vtkFiltersStatisticsModule.h" // For export macro
#include "vtkTableAlgorithm.h"
class vtkDataSet;
class vtkDoubleArray;
class vtkFieldData;
class vtkTable;
// .NAME vtkComputeQuartiles - Extract quartiles and extremum values
// of all columns of a table or all fields of a dataset.
//
......@@ -40,6 +28,18 @@ class vtkTable;
// .SECTION Thanks
// This class was written by Kitware SAS and supported by EDF - www.edf.fr
#ifndef vtkComputeQuartiles_h
#define vtkComputeQuartiles_h
#include "vtkFiltersStatisticsModule.h" // For export macro
#include "vtkTableAlgorithm.h"
class vtkDataSet;
class vtkDoubleArray;
class vtkFieldData;
class vtkTable;
class VTKFILTERSSTATISTICS_EXPORT vtkComputeQuartiles : public vtkTableAlgorithm
{
public:
......
......@@ -71,8 +71,6 @@
// .SECTION Thanks
// Thanks to Goodwin Lawlor and Prabhu Ramachandran for this class.
class vtkPropCollection;
#ifndef vtkGL2PSExporter_h
#define vtkGL2PSExporter_h
......@@ -81,6 +79,8 @@ class vtkPropCollection;
#include "vtkNew.h" // For vtkNew
class vtkPropCollection;
class VTKIOEXPORT_EXPORT vtkGL2PSExporter : public vtkExporter
{
public:
......
......@@ -15,7 +15,6 @@
// .NAME vtkXdmfReaderInternal -- private class(es) used by vtkXdmfReader
// .SECTION Description
// VTK-HeaderTest-Exclude: vtkXdmfReaderInternal.h
#ifndef vtkXdmfReaderInternal_h
#define vtkXdmfReaderInternal_h
......@@ -338,3 +337,4 @@ private:
};
#endif
// VTK-HeaderTest-Exclude: vtkXdmfReaderInternal.h
......@@ -22,7 +22,6 @@
//
// This file is a helper for the vtkXdmf3Reader and not intended to be
// part of VTK public API
// VTK-HeaderTest-Exclude: vtkXdmf3ArrayKeeper.h
#ifndef vtkXdmf3ArrayKeeper_h
#define vtkXdmf3ArrayKeeper_h
......@@ -62,3 +61,4 @@ private:
};
#endif //vtkXdmf3ArrayKeeper_h
// VTK-HeaderTest-Exclude: vtkXdmf3ArrayKeeper.h
......@@ -21,7 +21,6 @@
//
// This file is a helper for the vtkXdmf3Reader and not intended to be
// part of VTK public API
// VTK-HeaderTest-Exclude: vtkXdmf3ArraySelection.h
#ifndef vtkXdmf3ArraySelection_h
#define vtkXdmf3ArraySelection_h
......@@ -66,3 +65,4 @@ public:
};
#endif //# vtkXdmf3ArraySelection_h
// VTK-HeaderTest-Exclude: vtkXdmf3ArraySelection.h
......@@ -20,7 +20,6 @@
//
// This file is a helper for the vtkXdmf3Reader and vtkXdmf3Writer and
// not intended to be part of VTK public API
// VTK-HeaderTest-Exclude: vtkXdmf3DataSet.h
#ifndef vtkXdmf3DataSet_h
#define vtkXdmf3DataSet_h
......@@ -252,3 +251,4 @@ public:
};
#endif
// VTK-HeaderTest-Exclude: vtkXdmf3DataSet.h
......@@ -20,7 +20,6 @@
//
// This file is a helper for the vtkXdmf3Reader and not intended to be
// part of VTK public API
// VTK-HeaderTest-Exclude: vtkXdmf3HeavyDataHandler.h
#ifndef vtkXdmf3HeavyDataHandler_h
#define vtkXdmf3HeavyDataHandler_h
......@@ -128,3 +127,4 @@ protected:
};
#endif //vtkXdmf3HeavyDataHandler_h
// VTK-HeaderTest-Exclude: vtkXdmf3HeavyDataHandler.h
......@@ -21,7 +21,6 @@
//
// This file is a helper for the vtkXdmf3Reader and not intended to be
// part of VTK public API
// VTK-HeaderTest-Exclude: vtkXdmf3LightDataHandler.h
#ifndef vtkXdmf3LightDataHandler_h
#define vtkXdmf3LightDataHandler_h
......@@ -123,3 +122,4 @@ private:
};
#endif //vtkXdmf3LightDataHandler_h
// VTK-HeaderTest-Exclude: vtkXdmf3LightDataHandler.h
......@@ -22,7 +22,6 @@
//
// This file is a helper for the vtkXdmf3Reader and vtkXdmf3Writer and
// not intended to be part of VTK public API
// VTK-HeaderTest-Exclude: vtkXdmf3SILBuilder.h
#ifndef vtkXdmf3SILBuilder_h
#define vtkXdmf3SILBuilder_h
......@@ -68,3 +67,4 @@ public:
};
#endif //vtkXdmf3SILBuilder_h
// VTK-HeaderTest-Exclude: vtkXdmf3SILBuilder.h
......@@ -121,7 +121,6 @@ public:
// vanilla VTK code should use e.g:
//
// table_to_graph->SetInputConnection(1, vertex_table->output());
//
void SetVertexTableConnection(vtkAlgorithmOutput* in);
protected:
......
......@@ -59,7 +59,6 @@ public:
// Perform the layout of the input tree, and store the circle
// bounds of each vertex as a tuple in a data array.
// (Xcenter, Ycenter, Radius).
//
virtual void Layout(vtkTree *inputTree, vtkDataArray *areaArray,
vtkDataArray* sizeArray);
......
......@@ -31,7 +31,7 @@
// An array by default called "size" can be attached to the input tree
// that specifies the size of each leaf node in the tree. The filter will
// calculate the sizes of all interior nodes in the tree based on the sum
// of the leaf node sizes. If no "size" array is given in the input vtkTree,
// of the leaf node sizes. If no "size" array is given in the input vtkTree,
// a size of 1 is used for all leaf nodes to find the size of the interior nodes.
//
// .SECTION Thanks
......
......@@ -69,7 +69,7 @@
// .SECTION Thanks
// This class was written by Philippe Pebay, Kitware SAS 2012
// This work was supported by CEA/DIF - Commissariat a l'Energie Atomique,
// This work was supported by CEA/DIF - Commissariat a l'Energie Atomique,
// Centre DAM Ile-De-France, BP12, F-91297 Arpajon, France.
// .SECTION See Also
......
......@@ -12,15 +12,13 @@
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
// .NAME - Place points on the surface of polygonal data.
// .NAME vtkPolygonalSurfacePointPlacer - Place points on the surface of polygonal data.
//
// .SECTION Description
// vtkPolygonalSurfacePointPlacer places points on polygonal data and is
// meant to be used in conjunction with
// vtkPolygonalSurfaceContourLineInterpolator.
//
// .SECTION Usage
//
// .SECTION Caveats
// You should have computed cell normals for the input polydata if you are
// specifying a distance offset.
......
......@@ -334,7 +334,6 @@ public:
// to the x-edge in the bounding box where Y values are minimum and
// Z values are minimum. For a y-type axis, MAXMIN corresponds to the
// y-edge where X values are maximum and Z values are minimum.
//
vtkSetClampMacro(AxisPosition, int, VTK_AXIS_POS_MINMIN, VTK_AXIS_POS_MAXMIN);
vtkGetMacro(AxisPosition, int);
......
......@@ -45,7 +45,7 @@ All rights reserve
// Eric Brugger, Daniel Aguilera, Claire Guilbaud, Nicolas Dolegieviez,
// Aashish Chaudhary, Philippe Pebay, David Gobbi, David Partyka, Utkarsh Ayachit
// David Cole, Francois Bertel, and Mark Olesen
// Part of this work was supported by CEA/DIF - Commissariat a l'Energie Atomique,
// Part of this work was supported by CEA/DIF - Commissariat a l'Energie Atomique,
// Centre DAM Ile-De-France, BP12, F-91297 Arpajon, France.
//
// .section See Also
......
......@@ -74,7 +74,7 @@
// .SECTION Thanks
// This class was written by:
// Will Schroeder, Jim Miller, Charles Law, Sebastien Barre, Amy Squillacote,
// Ken Martin, Mathieu Malaterre, Jeff Lee, Francois Finet, Julien Bertel,
// Ken Martin, Mathieu Malaterre, Jeff Lee, Francois Finet, Julien Bertel,
// Claire Guilbaud, and Philippe Pebay
// .SECTION See Also
......
......@@ -278,7 +278,6 @@ public:
// licExtent : part of the inpute extent to compute on
// outputTexExtent : screen space extent of the output texture
// outputExtent : part of the output texture to store the result
//
vtkTextureObject *Execute(
const vtkPixelExtent &inputTexExtent,
const std::deque<vtkPixelExtent> &vectorExtent,
......
......@@ -280,7 +280,6 @@ public:
// licExtent : part of the inpute extent to compute on
// outputTexExtent : screen space extent of the output texture
// outputExtent : part of the output texture to store the result
//
vtkTextureObject *Execute(
const vtkPixelExtent &inputTexExtent,
const std::deque<vtkPixelExtent> &vectorExtent,
......
......@@ -97,17 +97,13 @@ public:
// Varyings and setting NumberOfVertices.
size_t GetBufferSize() const;
/*
* GL_SEPARATE_ATTRIBS is not supported yet.
*
// Description:
// GL_SEPARATE_ATTRIBS is not supported yet.
// The bufferMode argument to glTransformFeedbackVaryings. Must be
// GL_INTERLEAVED_ATTRIBS or GL_SEPARATE_ATTRIBS. Default is interleaved. Must
// be set prior to calling BindVaryings.
vtkSetMacro(BufferMode, int)
vtkGetMacro(BufferMode, int)
*
*/
//vtkSetMacro(BufferMode, int)
//vtkGetMacro(BufferMode, int)
// Description:
// Call glTransformFeedbackVaryings(). Must be called after the shaders are
......
......@@ -141,7 +141,6 @@ public:
// ...
// return vtkTesting::InteractorEventLoop( argc, argv, iren );
// }
//
static int InteractorEventLoop(int argc, char *argv[],
vtkRenderWindowInteractor *iren,
const char *stream = NULL);
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment