Commit 42900b7b authored by Kitware Robot's avatar Kitware Robot Committed by Shawn Waldon

Convert VTK style documentation to doxygen style (/**)

This was done automatically by running the script that was used already to
convert the documentation to doxygen style during the documentation
generation.

Commands:
/usr/bin/perl  $PWD/VTK/Utilities/Doxygen/doc_header2doxygen.pl  --to /tmp/tmpheaders --relativeto  $PWD/.  $PWD/Catalyst/Editions/Base/CoProcessing/Catalyst $PWD/Catalyst/Editions/Essentials/ParaViewCore/VTKExtensions/Default $PWD/Catalyst/Editions/Essentials/VTK/Filters/Extraction $PWD/Catalyst/Editions/Essentials/VTK/Filters/General $PWD/Catalyst/Editions/Extras/ParaViewCore/VTKExtensions/Rendering $PWD/Catalyst/Editions/Extras/VTK/Filters/Sources $PWD/Catalyst/Editions/Extras/VTK/IO/Legacy $PWD/Catalyst/Editions/Extras/VTK/IO/Parallel $PWD/Catalyst/Editions/Extras/VTK/IO/XML $PWD/Catalyst/Editions/Rendering-Base/ParaViewCore/ClientServerCore/Rendering $PWD/Catalyst/Editions/Rendering-Base/ParaViewCore/ServerManager/Default $PWD/Catalyst/Editions/Rendering-Base/VTK/Filters/Parallel $PWD/Catalyst/Editions/Rendering-Base/VTK/IO/Image $PWD/Catalyst/Editions/Rendering-Base/VTK/Interaction/Widgets $PWD/CoProcessing/Catalyst $PWD/CoProcessing/PythonCatalyst $PWD/CoProcessing/TestDriver $PWD/ParaViewCore/Animation $PWD/ParaViewCore/ClientServerCore/Core $PWD/ParaViewCore/ClientServerCore/Default $PWD/ParaViewCore/ClientServerCore/Rendering $PWD/ParaViewCore/ClientServerStream $PWD/ParaViewCore/Common $PWD/ParaViewCore/ServerImplementation/Core $PWD/ParaViewCore/ServerImplementation/Rendering $PWD/ParaViewCore/ServerManager/Core $PWD/ParaViewCore/ServerManager/Default $PWD/ParaViewCore/ServerManager/Rendering $PWD/ParaViewCore/ServerManager/SMApplication $PWD/ParaViewCore/VTKExtensions/CGNSReader $PWD/ParaViewCore/VTKExtensions/Core $PWD/ParaViewCore/VTKExtensions/CosmoTools $PWD/ParaViewCore/VTKExtensions/Default $PWD/ParaViewCore/VTKExtensions/Points $PWD/ParaViewCore/VTKExtensions/Rendering $PWD/Qt/ApplicationComponents $PWD/Qt/Components $PWD/Qt/Core $PWD/Qt/Deprecated $PWD/Qt/Python $PWD/Qt/Widgets $PWD/Web/Core $PWD/Web/Python $PWD/Web
\cp -rf /tmp/tmpheaders/* $PWD
parent ea1f4801
Pipeline #31551 passed with stage
......@@ -12,11 +12,14 @@
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
// .NAME vtkCustomUnstructuredGridBuilder - Class for creating unstructured grids.
// .SECTION Description
// Class for creating vtkUnstructuredGrids for a test driver. The
// UnstructuredGrid is built directly from a vtkUniformGrid to demonstrate
// how to input a grid into the coprocessor.
/**
* @class vtkCustomUnstructuredGridBuilder
* @brief Class for creating unstructured grids.
*
* Class for creating vtkUnstructuredGrids for a test driver. The
* UnstructuredGrid is built directly from a vtkUniformGrid to demonstrate
* how to input a grid into the coprocessor.
*/
#ifndef vtkCustomUnstructuredGridBuilder_h
#define vtkCustomUnstructuredGridBuilder_h
......@@ -36,23 +39,26 @@ public:
vtkTypeMacro(vtkCustomUnstructuredGridBuilder, vtkCPUnstructuredGridBuilder);
void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// Return a grid. BuiltNewGrid is set to 0 if the grids
// that were returned were already built before.
// vtkCustomUnstructuredGridBuilder will also delete the grid.
/**
* Return a grid. BuiltNewGrid is set to 0 if the grids
* that were returned were already built before.
* vtkCustomUnstructuredGridBuilder will also delete the grid.
*/
virtual vtkDataObject* GetGrid(unsigned long timeStep, double time,
int & builtNewGrid);
// Description:
// Customized function to build UnstructuredGrid.
/**
* Customized function to build UnstructuredGrid.
*/
void BuildGrid();
protected:
vtkCustomUnstructuredGridBuilder();
~vtkCustomUnstructuredGridBuilder();
// Description:
// Method to compute the centroid of Cell and return the values in xyz.
/**
* Method to compute the centroid of Cell and return the values in xyz.
*/
void ComputeCellCentroid(vtkGenericCell* cell, double xyz[3]);
private:
......
......@@ -12,11 +12,14 @@
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
// .NAME vtkPVCustomTestDriver - A custom test driver code that uses ParaView and python.
// .SECTION Description
// A custom test driver that creates a vtkUniformGrid with a single
// scalar point field named "Pressure". It runs a python script
// using ParaView.
/**
* @class vtkPVCustomTestDriver
* @brief A custom test driver code that uses ParaView and python.
*
* A custom test driver that creates a vtkUniformGrid with a single
* scalar point field named "Pressure". It runs a python script
* using ParaView.
*/
#ifndef vtkPVCustomTestDriver_h
#define vtkPVCustomTestDriver_h
......@@ -32,18 +35,21 @@ public:
vtkTypeMacro(vtkPVCustomTestDriver, vtkCPTestDriver);
void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// Run the test driver with the coprocessor.
// Returns 0 if there were no errors.
/**
* Run the test driver with the coprocessor.
* Returns 0 if there were no errors.
*/
virtual int Run();
// Description:
// Initialize the driver with the coprocessor. fileName is the
// name of the python script. Returns 0 on failure.
/**
* Initialize the driver with the coprocessor. fileName is the
* name of the python script. Returns 0 on failure.
*/
virtual int Initialize(const char* fileName);
// Description:
// Finalize the driver with the coprocessor.
/**
* Finalize the driver with the coprocessor.
*/
virtual int Finalize();
protected:
......@@ -54,9 +60,12 @@ private:
vtkPVCustomTestDriver(const vtkPVCustomTestDriver&) VTK_DELETE_FUNCTION;
void operator=(const vtkPVCustomTestDriver&) VTK_DELETE_FUNCTION;
// Description:
// The coprocessor to be called by this custom test.
//@{
/**
* The coprocessor to be called by this custom test.
*/
vtkCPProcessor* Processor;
};
//@}
#endif
......@@ -12,11 +12,14 @@
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
// .NAME vtkCPBaseFieldBuilder - Abstract class for specifying fields over grids.
// .SECTION Description
// Abstract class for specifying fields over grids for a test driver.
// May want to remove GetHighestFieldOrder as it is just a place holder
// for now.
/**
* @class vtkCPBaseFieldBuilder
* @brief Abstract class for specifying fields over grids.
*
* Abstract class for specifying fields over grids for a test driver.
* May want to remove GetHighestFieldOrder as it is just a place holder
* for now.
*/
#ifndef vtkCPBaseFieldBuilder_h
#define vtkCPBaseFieldBuilder_h
......@@ -32,16 +35,18 @@ public:
vtkTypeMacro(vtkCPBaseFieldBuilder, vtkObject);
void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// Return a grid. BuiltNewField is set to 0 if the grids
// that were returned were already built before.
// vtkCPBaseFieldBuilder will also delete the grid.
/**
* Return a grid. BuiltNewField is set to 0 if the grids
* that were returned were already built before.
* vtkCPBaseFieldBuilder will also delete the grid.
*/
virtual void BuildField(unsigned long TimeStep, double Time,
vtkDataSet* Grid) = 0;
// Description:
// Return the highest order of discretization of the field.
//virtual unsigned int GetHighestFieldOrder() = 0;
/**
* Return the highest order of discretization of the field.
* virtual unsigned int GetHighestFieldOrder() = 0;
*/
protected:
vtkCPBaseFieldBuilder();
......
......@@ -12,9 +12,12 @@
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
// .NAME vtkCPBaseGridBuilder - Abstract class for creating grids.
// .SECTION Description
// Abstract class for creating grids for a test driver.
/**
* @class vtkCPBaseGridBuilder
* @brief Abstract class for creating grids.
*
* Abstract class for creating grids for a test driver.
*/
#ifndef vtkCPBaseGridBuilder_h
#define vtkCPBaseGridBuilder_h
......@@ -30,9 +33,10 @@ public:
vtkTypeMacro(vtkCPBaseGridBuilder, vtkObject);
void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// Return a grid. BuiltNewGrid is 0 if the grid is the same
// as the last time step.
/**
* Return a grid. BuiltNewGrid is 0 if the grid is the same
* as the last time step.
*/
virtual vtkDataObject* GetGrid(unsigned long TimeStep, double Time,
int & BuiltNewGrid) = 0;
......
......@@ -12,9 +12,12 @@
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
// .NAME vtkCPCellFieldBuilder - Class for specifying cell fields over grids.
// .SECTION Description
// Class for specifying cell data fields over grids for a test driver.
/**
* @class vtkCPCellFieldBuilder
* @brief Class for specifying cell fields over grids.
*
* Class for specifying cell data fields over grids for a test driver.
*/
#ifndef vtkCPCellFieldBuilder_h
#define vtkCPCellFieldBuilder_h
......@@ -29,14 +32,16 @@ public:
vtkTypeMacro(vtkCPCellFieldBuilder, vtkCPFieldBuilder);
void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// Return a field on Grid.
/**
* Return a field on Grid.
*/
virtual void BuildField(unsigned long TimeStep, double Time,
vtkDataSet* Grid);
// Description:
// Return the highest order of discretization of the field.
//virtual unsigned int GetHighestFieldOrder();
/**
* Return the highest order of discretization of the field.
* virtual unsigned int GetHighestFieldOrder();
*/
protected:
vtkCPCellFieldBuilder();
......
......@@ -12,9 +12,12 @@
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
// .NAME vtkCPConstantScalarFieldFunction - Class for specifying constant scalars at points.
// .SECTION Description
// Class for specifying a constant scalar field.
/**
* @class vtkCPConstantScalarFieldFunction
* @brief Class for specifying constant scalars at points.
*
* Class for specifying a constant scalar field.
*/
#ifndef vtkCPConstantScalarFieldFunction_h
#define vtkCPConstantScalarFieldFunction_h
......@@ -29,15 +32,19 @@ public:
vtkTypeMacro(vtkCPConstantScalarFieldFunction, vtkCPScalarFieldFunction);
void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// Compute the field value at Point which is an array of length 3.
/**
* Compute the field value at Point which is an array of length 3.
*/
virtual double ComputeComponenentAtPoint(unsigned int component, double* point,
unsigned long timeStep, double time);
// Description:
// Set/get the constant value for the field.
//@{
/**
* Set/get the constant value for the field.
*/
vtkSetMacro(Constant, double);
vtkGetMacro(Constant, double);
//@}
protected:
vtkCPConstantScalarFieldFunction();
......@@ -47,9 +54,12 @@ private:
vtkCPConstantScalarFieldFunction(const vtkCPConstantScalarFieldFunction&) VTK_DELETE_FUNCTION;
void operator=(const vtkCPConstantScalarFieldFunction&) VTK_DELETE_FUNCTION;
// Description:
// The constant value for the scalar field.
//@{
/**
* The constant value for the scalar field.
*/
double Constant;
};
//@}
#endif
......@@ -12,9 +12,12 @@
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
// .NAME vtkCPFieldBuilder - Abstract class for specifying fields over grids.
// .SECTION Description
// Abstract class for specifying fields over grids for a test driver.
/**
* @class vtkCPFieldBuilder
* @brief Abstract class for specifying fields over grids.
*
* Abstract class for specifying fields over grids for a test driver.
*/
#ifndef vtkCPFieldBuilder_h
#define vtkCPFieldBuilder_h
......@@ -30,24 +33,32 @@ public:
vtkTypeMacro(vtkCPFieldBuilder, vtkCPBaseFieldBuilder);
void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// Return a field on Grid.
/**
* Return a field on Grid.
*/
virtual void BuildField(unsigned long TimeStep, double Time,
vtkDataSet* Grid) = 0;
// Description:
// Return the highest order of discretization of the field.
//virtual unsigned int GetHighestFieldOrder() = 0;
/**
* Return the highest order of discretization of the field.
* virtual unsigned int GetHighestFieldOrder() = 0;
*/
// Description:
// Set/get the name of the field array.
//@{
/**
* Set/get the name of the field array.
*/
vtkSetStringMacro(ArrayName);
vtkGetStringMacro(ArrayName);
//@}
// Description:
// Set/get TensorFieldFunction.
//@{
/**
* Set/get TensorFieldFunction.
*/
void SetTensorFieldFunction(vtkCPTensorFieldFunction* TFF);
vtkCPTensorFieldFunction* GetTensorFieldFunction();
//@}
protected: