Commit 6a46a5c3 authored by Sankhesh Jhaveri's avatar Sankhesh Jhaveri 💬
Browse files

Use three slashes for API sharing documentation comment

Referred to as doxygen member group, comment block inside
`///@{...///@}` is shared by all class members in the block. Prior to
this change, doxygen was not sharing the documentation across members.
The original code was using two slashes: `//@{...//@}`.
parent 4f21cad8
Pipeline #223350 waiting for manual action with stages
......@@ -106,14 +106,14 @@ public:
*/
void GetPointCells(vtkIdType ptId, vtkIdList* cellIds) override;
//@{
///@{
/**
* Locate the closest point to the global coordinate x. Return the
* point id. If point id < 0; then no point found. (This may arise
* when point is outside of dataset.)
*/
vtkIdType FindPoint(double x[3]) override;
//@}
///@}
/**
* Locate cell based on global coordinate x and tolerance
......@@ -172,13 +172,13 @@ public:
*/
int GetDataObjectType() override { return VTK_DATA_SET; }
//@{
///@{
/**
* Shallow and Deep copy.
*/
void ShallowCopy(vtkDataObject* src) override;
void DeepCopy(vtkDataObject* src) override;
//@}
///@}
protected:
vtkmDataSet();
......
......@@ -40,7 +40,7 @@ public:
void PrintSelf(ostream& os, vtkIndent indent) override;
static vtkmCleanGrid* New();
//@{
///@{
/**
* Get/Set if the points from the input that are unused in the output should
* be removed. This will take extra time but the result dataset may use
......@@ -49,7 +49,7 @@ public:
vtkSetMacro(CompactPoints, bool);
vtkGetMacro(CompactPoints, bool);
vtkBooleanMacro(CompactPoints, bool);
//@}
///@}
protected:
vtkmCleanGrid();
......
......@@ -63,7 +63,7 @@ public:
vtkMTimeType GetMTime() override;
//@{
///@{
/**
* When this flag is off (the default), then the computation will fall back
* to the serial VTK version if VTK-m fails to run. When the flag is on,
......@@ -73,7 +73,7 @@ public:
vtkGetMacro(ForceVTKm, vtkTypeBool);
vtkSetMacro(ForceVTKm, vtkTypeBool);
vtkBooleanMacro(ForceVTKm, vtkTypeBool);
//@}
///@}
protected:
vtkmClip();
......
......@@ -50,7 +50,7 @@ public:
*/
vtkUnstructuredGrid* GetOutput();
//@{
///@{
/**
* Get/Set if the points from the input that are unused in the output should
* be removed. This will take extra time but the result dataset may use
......@@ -59,7 +59,7 @@ public:
vtkSetMacro(CompactPoints, bool);
vtkGetMacro(CompactPoints, bool);
vtkBooleanMacro(CompactPoints, bool);
//@}
///@}
protected:
vtkmExternalFaces();
......
......@@ -45,7 +45,7 @@ public:
void PrintSelf(ostream& os, vtkIndent indent) override;
static vtkmExtractVOI* New();
//@{
///@{
/**
* When this flag is off (the default), then the computation will fall back
* to the serial VTK version if VTK-m fails to run. When the flag is on,
......@@ -55,7 +55,7 @@ public:
vtkGetMacro(ForceVTKm, vtkTypeBool);
vtkSetMacro(ForceVTKm, vtkTypeBool);
vtkBooleanMacro(ForceVTKm, vtkTypeBool);
//@}
///@}
protected:
vtkmExtractVOI();
......
......@@ -43,7 +43,7 @@ public:
void PrintSelf(ostream& os, vtkIndent indent) override;
static vtkmGradient* New();
//@{
///@{
/**
* When this flag is off (the default), then the computation will fall back
* to the serial VTK version if VTK-m fails to run. When the flag is on,
......@@ -53,7 +53,7 @@ public:
vtkGetMacro(ForceVTKm, vtkTypeBool);
vtkSetMacro(ForceVTKm, vtkTypeBool);
vtkBooleanMacro(ForceVTKm, vtkTypeBool);
//@}
///@}
protected:
vtkmGradient();
......
......@@ -38,24 +38,24 @@ public:
void PrintSelf(ostream& os, vtkIndent indent) override;
static vtkmHistogram* New();
//@{
///@{
/**
* Specify number of bins. Default is 10.
*/
vtkSetMacro(NumberOfBins, size_t);
vtkGetMacro(NumberOfBins, size_t);
//@}
///@}
//@{
///@{
/**
* Specify the range to use to generate the histogram. They are only used when
* UseCustomBinRanges is set to true.
*/
vtkSetVector2Macro(CustomBinRange, double);
vtkGetVector2Macro(CustomBinRange, double);
//@}
///@}
//@{
///@{
/**
* When set to true, CustomBinRanges will be used instead of using the full
* range for the selected array. By default, set to false.
......@@ -63,9 +63,9 @@ public:
vtkSetMacro(UseCustomBinRanges, bool);
vtkGetMacro(UseCustomBinRanges, bool);
vtkBooleanMacro(UseCustomBinRanges, bool);
//@}
///@}
//@{
///@{
/**
* Get/Set if first and last bins must be centered around the min and max
* data. This is only used when UseCustomBinRanges is set to false.
......@@ -74,21 +74,21 @@ public:
vtkSetMacro(CenterBinsAroundMinAndMax, bool);
vtkGetMacro(CenterBinsAroundMinAndMax, bool);
vtkBooleanMacro(CenterBinsAroundMinAndMax, bool);
//@}
///@}
//@{
///@{
/**
* Return the range used to generate the histogram.
*/
vtkGetVectorMacro(ComputedRange, double, 2);
//@}
///@}
//@{
///@{
/**
* Return the bin delta of the computed field.
*/
vtkGetMacro(BinDelta, double);
//@}
///@}
protected:
vtkmHistogram();
......
......@@ -39,7 +39,7 @@ public:
static vtkmPointElevation* New();
//@{
///@{
/**
* When this flag is off (the default), then the computation will fall back
* to the serial VTK version if VTK-m fails to run. When the flag is on,
......@@ -49,7 +49,7 @@ public:
vtkGetMacro(ForceVTKm, vtkTypeBool);
vtkSetMacro(ForceVTKm, vtkTypeBool);
vtkBooleanMacro(ForceVTKm, vtkTypeBool);
//@}
///@}
protected:
vtkmPointElevation();
......
......@@ -37,13 +37,13 @@ public:
static vtkmPointTransform* New();
//@{
///@{
/**
* Specify the transform object used to transform the points
*/
void SetTransform(vtkHomogeneousTransform* tf);
vtkGetObjectMacro(Transform, vtkHomogeneousTransform);
//@}
///@}
int FillInputPortInformation(int port, vtkInformation* info) override;
......
......@@ -52,7 +52,7 @@ public:
void PrintSelf(ostream& os, vtkIndent indent) override;
static vtkmPolyDataNormals* New();
//@{
///@{
/**
* When this flag is off (the default), then the computation will fall back
* to the serial VTK version if VTK-m fails to run. When the flag is on,
......@@ -62,7 +62,7 @@ public:
vtkGetMacro(ForceVTKm, vtkTypeBool);
vtkSetMacro(ForceVTKm, vtkTypeBool);
vtkBooleanMacro(ForceVTKm, vtkTypeBool);
//@}
///@}
protected:
vtkmPolyDataNormals();
......
......@@ -56,7 +56,7 @@ public:
void PrintSelf(ostream& os, vtkIndent indent) override;
static vtkmProbe* New();
//@{
///@{
/**
* Specify the data set that will be probed at the input points.
* The Input gives the geometry (the points and cells) for the output,
......@@ -65,9 +65,9 @@ public:
*/
void SetSourceData(vtkDataObject* source);
vtkDataObject* GetSource();
//@}
///@}
//@}
///@}
/**
* Specify the data set that will be probed at the input points.
* The Input gives the geometry (the points and cells) for the output,
......@@ -75,9 +75,9 @@ public:
* vectors, etc. for the output points based on the point locations.
*/
void SetSourceConnection(vtkAlgorithmOutput* algOutput);
//@}
///@}
//@{
///@{
/**
* Shallow copy the input cell data arrays to the output.
* Off by default.
......@@ -85,8 +85,8 @@ public:
vtkSetMacro(PassCellArrays, vtkTypeBool);
vtkBooleanMacro(PassCellArrays, vtkTypeBool);
vtkGetMacro(PassCellArrays, vtkTypeBool);
//@}
//@{
///@}
///@{
/**
* Shallow copy the input point data arrays to the output.
* Off by default.
......@@ -94,9 +94,9 @@ public:
vtkSetMacro(PassPointArrays, vtkTypeBool);
vtkBooleanMacro(PassPointArrays, vtkTypeBool);
vtkGetMacro(PassPointArrays, vtkTypeBool);
//@}
///@}
//@{
///@{
/**
* Set whether to pass the field-data arrays from the Input i.e. the input
* providing the geometry to the output. On by default.
......@@ -104,9 +104,9 @@ public:
vtkSetMacro(PassFieldArrays, vtkTypeBool);
vtkBooleanMacro(PassFieldArrays, vtkTypeBool);
vtkGetMacro(PassFieldArrays, vtkTypeBool);
//@}
///@}
//@{
///@{
/**
* Returns the name of the valid point array added to the output with values 2 for
* hidden points and 0 for valid points.
......@@ -114,9 +114,9 @@ public:
*/
vtkSetMacro(ValidPointMaskArrayName, std::string);
vtkGetMacro(ValidPointMaskArrayName, std::string);
//@}
///@}
//@{
///@{
/**
* Returns the name of the valid cell array added to the output with values 2 for
* hidden points and 0 for valid points.
......@@ -124,7 +124,7 @@ public:
*/
vtkSetMacro(ValidCellMaskArrayName, std::string);
vtkGetMacro(ValidCellMaskArrayName, std::string);
//@}
///@}
protected:
vtkmProbe();
......
......@@ -42,7 +42,7 @@ public:
static vtkmThreshold* New();
//@{
///@{
/**
* When this flag is off (the default), then the computation will fall back
* to the serial VTK version if VTK-m fails to run. When the flag is on,
......@@ -52,7 +52,7 @@ public:
vtkGetMacro(ForceVTKm, vtkTypeBool);
vtkSetMacro(ForceVTKm, vtkTypeBool);
vtkBooleanMacro(ForceVTKm, vtkTypeBool);
//@}
///@}
protected:
vtkmThreshold();
......
......@@ -58,7 +58,7 @@ public:
void PrintSelf(ostream& os, vtkIndent indent) override;
static vtkmTriangleMeshPointNormals* New();
//@{
///@{
/**
* When this flag is off (the default), then the computation will fall back
* to the serial VTK version if VTK-m fails to run. When the flag is on,
......@@ -68,7 +68,7 @@ public:
vtkGetMacro(ForceVTKm, vtkTypeBool);
vtkSetMacro(ForceVTKm, vtkTypeBool);
vtkBooleanMacro(ForceVTKm, vtkTypeBool);
//@}
///@}
protected:
vtkmTriangleMeshPointNormals();
......
......@@ -95,45 +95,45 @@ public:
*/
static vtkAxis* New();
//@{
///@{
/**
* Get/set the position of the axis (LEFT, BOTTOM, RIGHT, TOP, PARALLEL).
*/
virtual void SetPosition(int position);
vtkGetMacro(Position, int);
//@}
///@}
//@{
///@{
/**
* Set point 1 of the axis (in pixels), this is usually the origin.
*/
void SetPoint1(const vtkVector2f& pos);
void SetPoint1(float x, float y);
//@}
///@}
//@{
///@{
/**
* Get point 1 of the axis (in pixels), this is usually the origin.
*/
vtkGetVector2Macro(Point1, float);
vtkVector2f GetPosition1();
//@}
///@}
//@{
///@{
/**
* Set point 2 of the axis (in pixels), this is usually the terminus.
*/
void SetPoint2(const vtkVector2f& pos);
void SetPoint2(float x, float y);
//@}
///@}
//@{
///@{
/**
* Get point 2 of the axis (in pixels), this is usually the terminus.
*/
vtkGetVector2Macro(Point2, float);
vtkVector2f GetPosition2();
//@}
///@}
/**
* Set the number of tick marks for this axis. Default is -1, which leads to
......@@ -141,28 +141,28 @@ public:
*/
virtual void SetNumberOfTicks(int numberOfTicks);
//@{
///@{
/**
* Get the number of tick marks for this axis.
*/
vtkGetMacro(NumberOfTicks, int);
//@}
///@}
//@{
///@{
/**
* Get/set the length of tick marks (in pixels).
*/
vtkSetMacro(TickLength, float);
vtkGetMacro(TickLength, float);
//@}
///@}
//@{
///@{
/**
* Get the vtkTextProperty that governs how the axis labels are displayed.
* Note that the alignment properties are not used.
*/
vtkGetObjectMacro(LabelProperties, vtkTextProperty);
//@}
///@}
/**
* Set the logical minimum value of the axis, in plot coordinates.
......@@ -171,14 +171,14 @@ public:
*/
virtual void SetMinimum(double minimum);
//@{
///@{
/**
* Get the logical minimum value of the axis, in plot coordinates.
* If LogScaleActive is true (not just LogScale), then this
* returns the minimum base-10 <b>exponent</b>.
*/
vtkGetMacro(Minimum, double);
//@}
///@}
/**
* Set the logical maximum value of the axis, in plot coordinates.
......@@ -187,14 +187,14 @@ public:
*/
virtual void SetMaximum(double maximum);
//@{
///@{
/**
* Get the logical maximum value of the axis, in plot coordinates.
* If LogScaleActive is true (not just LogScale), then this
* returns the maximum base-10 <b>exponent</b>.
*/
vtkGetMacro(Maximum, double);
//@}
///@}
/**
* Set the logical, unscaled minimum value of the axis, in plot coordinates.
......@@ -203,26 +203,26 @@ public:
*/
virtual void SetUnscaledMinimum(double minimum);
//@{
///@{
/**
* Get the logical minimum value of the axis, in plot coordinates.
*/
vtkGetMacro(UnscaledMinimum, double);
//@}
///@}
/**
* Set the logical maximum value of the axis, in plot coordinates.
*/
virtual void SetUnscaledMaximum(double maximum);
//@{
///@{
/**
* Get the logical maximum value of the axis, in plot coordinates.
*/
vtkGetMacro(UnscaledMaximum, double);
//@}
///@}
//@{
///@{
/**
* Set the logical range of the axis, in plot coordinates.
......@@ -236,9 +236,9 @@ public:
virtual void SetRange(double range[2]);
virtual void SetUnscaledRange(double minimum, double maximum);
virtual void SetUnscaledRange(double range[2]);
//@}
///@}
//@{
///@{
/**
* Get the logical range of the axis, in plot coordinates.
......@@ -248,86 +248,86 @@ public:
*/
virtual void GetRange(double* range);
virtual void GetUnscaledRange(double* range);
//@}
///@}
/**
* Set the logical lowest possible value for \a Minimum, in plot coordinates.
*/
virtual void SetMinimumLimit(double lowest);
//@{
///@{
/**
* Get the logical lowest possible value for \a Minimum, in plot coordinates.
*/
vtkGetMacro(MinimumLimit, double);
//@}
///@}
/**
* Set the logical highest possible value for \a Maximum, in plot coordinates.
*/
virtual void SetMaximumLimit(double highest);
//@{
///@{
/**
* Get the logical highest possible value for \a Maximum, in plot coordinates.
*/
vtkGetMacro(MaximumLimit, double);
//@}
///@}
/**
* Set the logical lowest possible value for \a Minimum, in plot coordinates.
*/
virtual void SetUnscaledMinimumLimit(double lowest);
//@{
///@{
/**
* Get the logical lowest possible value for \a Minimum, in plot coordinates.
*/
vtkGetMacro(UnscaledMinimumLimit, double);
//@}
///@}
/**
* Set the logical highest possible value for \a Maximum, in plot coordinates.
*/
virtual void SetUnscaledMaximumLimit(double highest);
//@{
///@{
/**
* Get the logical highest possible value for \a Maximum, in plot coordinates.
*/
vtkGetMacro(UnscaledMaximumLimit, double);
//@}
///@}
//@{
///@{
/**
* Get the margins of the axis, in pixels.
*/
vtkGetVector2Macro(Margins, int);
//@}
///@}
//@{
///@{
/**
* Set the margins of the axis, in pixels.
*/
vtkSetVector2Macro(Margins, int);
//@}
///@}
//@{
///@{
/**
* Get/set the title text of the axis.
*/
virtual void SetTitle(const vtkStdString& title);
virtual vtkStdString GetTitle();
//@}
///@}
//@{
///@{
/**
* Get the vtkTextProperty that governs how the axis title is displayed.
*/
vtkGetObjectMacro(TitleProperties, vtkTextProperty);
//@}