Commit f0573314 authored by David Gobbi's avatar David Gobbi

Fix a few ill-formed doxygen groups

I used perl regex to find any groups that spanned a protected: or
private: access specifier.
parent b9da59ab
......@@ -37,10 +37,11 @@ public:
*/
vtkSetMacro(IsoValue, float);
vtkGetMacro(IsoValue, float);
//@}
protected:
vtkPistonContour();
~vtkPistonContour();
//@}
/**
* Method that does the actual calculation. Funnels down to ExecuteData.
......
......@@ -45,10 +45,11 @@ public:
*/
vtkSetMacro(MaxValue, float);
vtkGetMacro(MaxValue, float);
//@}
protected:
vtkPistonThreshold();
~vtkPistonThreshold();
//@}
/**
* Method that does the actual calculation.
......
......@@ -102,7 +102,6 @@ public:
const vtkVector2f& tolerance,
vtkVector2f* location);
//@{
/**
* Generate and return the tooltip label string for this plot
* The segmentIndex parameter is ignored, except for vtkPlotBar
......@@ -110,10 +109,10 @@ public:
virtual vtkStdString GetTooltipLabel(const vtkVector2d &plotPos,
vtkIdType seriesIndex,
vtkIdType segmentIndex);
protected:
vtkPlotArea();
~vtkPlotArea();
//@}
/**
* Name of the valid point mask array.
......
......@@ -124,15 +124,14 @@ public:
*/
virtual bool SelectPoints(const vtkVector2f& min, const vtkVector2f& max);
//@{
/**
* Select all points in the specified polygon.
*/
virtual bool SelectPointsInPolygon(const vtkContextPolygon &polygon);
protected:
vtkPlotFunctionalBag();
~vtkPlotFunctionalBag();
//@}
/**
* Populate the data arrays ready to operate on input data.
......
......@@ -61,16 +61,15 @@ public:
*/
virtual void Initialize(vtkAbstractArray* array) = 0;
//@{
/**
* Get the data type from the underlying array. Returns 0 if
* no underlying array is present.
*/
virtual int GetDataType()=0;
protected:
vtkArrayIterator();
~vtkArrayIterator() VTK_OVERRIDE;
//@}
private:
vtkArrayIterator(const vtkArrayIterator&) VTK_DELETE_FUNCTION;
......
......@@ -102,15 +102,14 @@ public:
*/
int GetDataTypeSize();
//@{
/**
* This is the data type for the value.
*/
typedef T ValueType;
protected:
vtkArrayIteratorTemplate();
~vtkArrayIteratorTemplate() VTK_OVERRIDE;
//@}
T* Pointer;
private:
......
......@@ -147,10 +147,11 @@ public:
*/
void Register(vtkObjectBase* o) VTK_OVERRIDE;
void UnRegister(vtkObjectBase* o) VTK_OVERRIDE;
//@}
protected:
vtkCollection();
~vtkCollection() VTK_OVERRIDE;
//@}
virtual void RemoveElement(vtkCollectionElement *element,
vtkCollectionElement *previous);
......
......@@ -148,15 +148,14 @@ public:
int defaultStatus);
//@}
//@{
/**
* Copy the selections from the given vtkDataArraySelection instance.
*/
void CopySelections(vtkDataArraySelection* selections);
protected:
vtkDataArraySelection();
~vtkDataArraySelection() VTK_OVERRIDE;
//@}
// Internal implementation details.
vtkDataArraySelectionInternals* Internal;
......
......@@ -64,10 +64,11 @@ public:
*/
void freeze();
void freeze(int);
//@}
protected:
// The pointer returned by str().
char* Result;
//@}
// Whether the caller of str() owns the memory.
int Frozen;
......
......@@ -75,18 +75,26 @@ public:
{
return this->ObjectFactory;
}
//@{
/**
* Set the class override name
*/
vtkSetStringMacro(ClassOverrideName);
// Set the class override with name
/**
* Set the class override with name
*/
vtkSetStringMacro(ClassOverrideWithName);
// Set the description
/**
* Set the description
*/
vtkSetStringMacro(Description);
//@}
protected:
virtual void SetObjectFactory(vtkObjectFactory*);
//@}
private:
vtkOverrideInformation();
......
......@@ -77,7 +77,6 @@ public:
static void ComputeInterpolationWeights(double x[3], vtkPoints *pts,
vtkIdList *tris, double *weights);
//@{
/**
* Method to generate interpolation weights for a point x[3] from a list of
* polygonal faces. In this version of the method, the faces are defined by
......@@ -87,10 +86,10 @@ public:
*/
static void ComputeInterpolationWeights(double x[3], vtkPoints *pts,
vtkCellArray *tris, double *weights);
protected:
vtkMeanValueCoordinatesInterpolator();
~vtkMeanValueCoordinatesInterpolator() VTK_OVERRIDE;
//@}
/**
* Internal method that sets up the processing of triangular meshes.
......
......@@ -46,15 +46,14 @@ public:
*/
vtkClientSocket* WaitForConnection(unsigned long msec=0);
//@{
/**
* Returns the port on which the server is running.
*/
int GetServerPort();
protected:
vtkServerSocket();
~vtkServerSocket() VTK_OVERRIDE;
//@}
private:
vtkServerSocket(const vtkServerSocket&) VTK_DELETE_FUNCTION;
......
......@@ -61,15 +61,12 @@ public:
*/
int Receive(void* data, int length, int readFully=1);
//@{
/**
* Provides access to the internal socket descriptor. This is valid only when
* GetConnected() returns true.
*/
vtkGetMacro(SocketDescriptor, int);
//@}
//@{
/**
* Selects set of sockets. Returns 0 on timeout, -1 on error.
* 1 on success. Selected socket's index is returned thru
......@@ -77,10 +74,10 @@ public:
*/
static int SelectSockets(const int* sockets_to_select, int size,
unsigned long msec, int* selected_index);
protected:
vtkSocket();
~vtkSocket() VTK_OVERRIDE;
//@}
int SocketDescriptor;
......
......@@ -61,10 +61,11 @@ public:
void RemoveItem(int i);
void RemoveItem(vtkObject *);
void RemoveAllItems();
//@}
protected:
vtkSocketCollection();
~vtkSocketCollection() VTK_OVERRIDE;
//@}
vtkSocket* SelectedSocket;
private:
......
......@@ -100,15 +100,14 @@ protected:
double BundlingStrength;
bool DirectMapping;
//@{
/**
* Convert the vtkGraph into vtkPolyData.
*/
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *);
private:
vtkGraphHierarchicalBundle(const vtkGraphHierarchicalBundle&) VTK_DELETE_FUNCTION;
void operator=(const vtkGraphHierarchicalBundle&) VTK_DELETE_FUNCTION;
};
//@}
#endif
......@@ -110,9 +110,10 @@ public:
vtkSetMacro(InvertMeanCurvature,int);
vtkGetMacro(InvertMeanCurvature,int);
vtkBooleanMacro(InvertMeanCurvature,int);
//@}
protected:
vtkCurvatures();
//@}
// Usual data generation method
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *);
......
......@@ -129,16 +129,15 @@ protected:
*/
virtual int ComputeOutlierThresholds(vtkImageData* histogram, vtkDoubleArray* thresholds, double threshold);
//@{
/**
* Take a set of range thresholds (bin extents) and filter out rows from the input table data that
* fits inside those thresholds.
*/
virtual int FillOutlierIds(vtkTable* data, vtkCollection* thresholds, vtkIdTypeArray* rowIds, vtkTable* outTable);
private:
vtkComputeHistogram2DOutliers(const vtkComputeHistogram2DOutliers&) VTK_DELETE_FUNCTION;
void operator=(const vtkComputeHistogram2DOutliers&) VTK_DELETE_FUNCTION;
};
//@}
#endif
......@@ -240,15 +240,14 @@ protected:
vtkInformationVector **inputVector,
vtkInformationVector *outputVector);
//@{
/**
* Get points to the arrays that live in the two input columns
*/
int GetInputArrays(vtkDataArray*& col1, vtkDataArray*& col2);
private:
vtkExtractHistogram2D(const vtkExtractHistogram2D&) VTK_DELETE_FUNCTION;
void operator=(const vtkExtractHistogram2D&) VTK_DELETE_FUNCTION;
};
//@}
#endif
......@@ -169,7 +169,6 @@ protected:
vtkCompositeDataSet* output,
vtkCompositeDataSet* input);
//@{
/**
* Generate a name for a piece in the periodic dataset from the input dataset
*/
......@@ -177,10 +176,10 @@ protected:
vtkCompositeDataIterator* inputLoc,
vtkMultiPieceDataSet* output,
vtkIdType outputId);
private:
vtkAngularPeriodicFilter(const vtkAngularPeriodicFilter&) VTK_DELETE_FUNCTION;
void operator=(const vtkAngularPeriodicFilter&) VTK_DELETE_FUNCTION;
//@}
bool ComputeRotationsOnTheFly;
......
......@@ -50,10 +50,11 @@ public:
*/
virtual void SetController(vtkMultiProcessController*);
vtkGetObjectMacro(Controller,vtkMultiProcessController);
//@}
protected:
vtkPBivariateLinearTableThreshold();
virtual ~vtkPBivariateLinearTableThreshold();
//@}
virtual int RequestData(
vtkInformation*,
......
......@@ -212,6 +212,7 @@ protected:
*/
virtual int ApplyThreshold(vtkTable* tableToThreshold, vtkIdTypeArray* acceptedIds);
//@{
/**
* Determine if x,y is above all specified lines.
*/
......@@ -227,15 +228,15 @@ protected:
*/
int ThresholdNear(double x, double y);
//@{
/**
* Determine if x,y is between ANY TWO of the specified lines.
*/
int ThresholdBetween(double x, double y);
//@}
private:
vtkBivariateLinearTableThreshold(const vtkBivariateLinearTableThreshold&) VTK_DELETE_FUNCTION;
void operator=(const vtkBivariateLinearTableThreshold&) VTK_DELETE_FUNCTION;
};
//@}
#endif
......@@ -52,7 +52,6 @@ public:
*/
size_t Read(void* data, size_t length);
//@{
/**
* Called after all desired calls to Seek and Read have been made.
* After this call, the caller is free to change the position of the
......@@ -60,10 +59,10 @@ public:
* call to StartReading.
*/
void EndReading();
protected:
vtkBase64InputStream();
~vtkBase64InputStream();
//@}
// Number of decoded bytes left in Buffer from last call to Read.
int BufferLength;
......
......@@ -73,7 +73,6 @@ public:
vtkUnsignedCharArray* Compress(unsigned char const* uncompressedData,
size_t uncompressedSize);
//@{
/**
* Uncompress the given data. A vtkUnsignedCharArray containing the
* compressed data is returned with a reference count of 1. The
......@@ -84,10 +83,10 @@ public:
vtkUnsignedCharArray* Uncompress(unsigned char const* compressedData,
size_t compressedSize,
size_t uncompressedSize);
protected:
vtkDataCompressor();
~vtkDataCompressor();
//@}
// Actual compression method. This must be provided by a subclass.
// Must return the size of the compressed data, or zero on error.
......
......@@ -89,16 +89,15 @@ public:
*/
char *RegisterAndGetOutputString();
//@{
/**
* Internal method: Returns the "string" with the "StringDelimiter" if
* UseStringDelimiter is true.
*/
vtkStdString GetString(vtkStdString string);
protected:
vtkDelimitedTextWriter();
~vtkDelimitedTextWriter();
//@}
bool WriteToOutputString;
char* OutputString;
......
......@@ -78,11 +78,11 @@ public:
vtkSetClampMacro(Fastest, int, 0, 1);
vtkBooleanMacro(Fastest, int);
vtkGetMacro(Fastest, int);
//@}
protected:
vtkX3DExporterFIWriter();
~vtkX3DExporterFIWriter();
//@}
private:
void StartAttribute(int attributeID, bool literal, bool addToTable = false);
......
......@@ -169,28 +169,27 @@ public:
*/
virtual void SetField(int attributeID, const double* values, size_t size) = 0;
/**
* Sets the field specified with attributeID
* of the active node to the given value.
* The type of the field is specified with type
* It is possible to specify that the field is an
* image for optimized formating or compression
* Supported types: MFINT32, SFIMAGE
*/
/**
* Sets the field specified with attributeID
* of the active node to the given value.
* The type of the field is specified with type
* It is possible to specify that the field is an
* image for optimized formating or compression
* Supported types: MFINT32, SFIMAGE
*/
virtual void SetField(int attributeID, const int* values, size_t size, bool image = false) = 0;
//@{
/**
/*
* Sets the field specified with attributeID
* of the active node to the given value.
* The type of the field is specified with type
* Supported types: MFString
* virtual void SetField(int attributeID, int type, std::string) = 0;
*/
// virtual void SetField(int attributeID, int type, std::string) = 0;
protected:
vtkX3DExporterWriter();
~vtkX3DExporterWriter();
//@}
char *OutputString;
int OutputStringLength;
......
......@@ -254,7 +254,7 @@ protected:
void* clientdata, void* calldata);
virtual int FillOutputPortInformation(int, vtkInformation*);
//@{
/**
* We intercept the requests to check for which port
* information is being requested for and if there is
......@@ -264,9 +264,9 @@ protected:
int ProcessRequest(vtkInformation *request,
vtkInformationVector **inInfo,
vtkInformationVector *outInfo);
private:
WindBladeReaderInternal * Internal;
//@}
vtkWindBladeReader(const vtkWindBladeReader&) VTK_DELETE_FUNCTION;
void operator=(const vtkWindBladeReader&) VTK_DELETE_FUNCTION;
......
......@@ -64,16 +64,15 @@ public:
VTK_NEWINSTANCE
static vtkImageReader2* CreateImageReader2(const char* path);
//@{
/**
* The caller must allocate the vtkImageReader2Collection and pass in the
* pointer to this method.
*/
static void GetRegisteredReaders(vtkImageReader2Collection* );
protected:
vtkImageReader2Factory();
~vtkImageReader2Factory();
//@}
static void InitializeReaders();
......
......@@ -76,10 +76,11 @@ public:
vtkSetMacro(Subsampling, int);
vtkGetMacro(Subsampling, int);
vtkBooleanMacro(Subsampling, int);
//@}
protected:
vtkOggTheoraWriter();
~vtkOggTheoraWriter();
//@}
vtkOggTheoraWriterInternal *Internals;
......
......@@ -144,16 +144,15 @@ protected:
vtkMultiProcessController* Controller;
//@{
/**
* Valid at end of WriteInternal to indicate if we're going to continue
* execution.
*/
vtkGetMacro(ContinuingExecution, bool);
private:
vtkXMLPDataWriter(const vtkXMLPDataWriter&) VTK_DELETE_FUNCTION;
void operator=(const vtkXMLPDataWriter&) VTK_DELETE_FUNCTION;
//@}
/**
* Method used to delete all written files.
......
......@@ -59,16 +59,15 @@ public:
vtkBooleanMacro(WholeSlices, int);
//@}
//@{
/**
* For the specified port, copy the information this reader sets up in
* SetupOutputInformation to outInfo
*/
virtual void CopyOutputInformation(vtkInformation *outInfo, int port);
protected:
vtkXMLStructuredDataReader();
~vtkXMLStructuredDataReader();
//@}
virtual void SetOutputExtent(int* extent)=0;
int ReadPrimaryElement(vtkXMLDataElement* ePrimary);
......
......@@ -123,10 +123,11 @@ public:
vtkGetMacro(ForegroundValue, double);
vtkSetMacro(BackgroundValue, double);
vtkGetMacro(BackgroundValue, double);
//@}
protected:
vtkVoxelModeller();
~vtkVoxelModeller() {}
//@}
virtual int RequestInformation (vtkInformation *,
vtkInformationVector **,
......
......@@ -185,7 +185,6 @@ public:
*/
vtkIdType GetTotal() { return this->Total; }
//@{
/**
* This is part of the executive, but is public so that it can be accessed
* by non-member functions.
......@@ -195,10 +194,10 @@ public:
vtkInformationVector *outputVector,
vtkImageData ***inData,
vtkImageData **outData, int ext[6], int id);
protected:
vtkImageHistogram();
~vtkImageHistogram();
//@}
virtual int RequestUpdateExtent(vtkInformation *vtkNotUsed(request),
vtkInformationVector **inInfo,
......
......@@ -101,15 +101,14 @@ protected:
double BundlingStrength;
bool DirectMapping;
//@{
/**
* Convert the vtkGraph into vtkPolyData.
*/
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *);
private:
vtkGraphHierarchicalBundleEdges(const vtkGraphHierarchicalBundleEdges&) VTK_DELETE_FUNCTION;
void operator=(const vtkGraphHierarchicalBundleEdges&) VTK_DELETE_FUNCTION;
};
//@}
#endif
......@@ -128,15 +128,14 @@ protected:
vtkVariant DefaultValue;
//@{
/**
* Convert the vtkGraph into vtkPolyData.
*/
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *);
private:
vtkTransferAttributes(const vtkTransferAttributes&) VTK_DELETE_FUNCTION;
void operator=(const vtkTransferAttributes&) VTK_DELETE_FUNCTION;
};
//@}
#endif
......@@ -82,10 +82,11 @@ public:
vtkSetMacro(LogScale, bool);
vtkGetMacro(LogScale, bool);
vtkBooleanMacro(LogScale, bool);
//@}
protected:
vtkTreeFieldAggregator();
~vtkTreeFieldAggregator();
//@}
int RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *);
......
......@@ -97,27 +97,32 @@ public:
virtual void OnLeave();
//@}
//@{
virtual void StartInspect(int x, int y);
virtual void Inspect(int x, int y);
virtual void EndInspect();
//@}
//@{
virtual void StartZoom();
virtual void Zoom();
virtual void EndZoom();
//@}
//@{
virtual void StartPan();
virtual void Pan();
virtual void EndPan();
//@}
//@{
/**
* Override the "fly-to" (f keypress) for images.
*/
virtual void OnChar();
protected:
vtkParallelCoordinatesInteractorStyle();
~vtkParallelCoordinatesInteractorStyle();
//@}
int CursorStartPosition[2];
int CursorCurrentPosition[2];
......
......@@ -284,7 +284,6 @@ public:
vtkBooleanMacro(UseSsend, int);
//@}
//@{
/**
* Copies all the attributes of source, deleting previously
* stored data. The MPI communicator handle is also copied.
......@@ -293,10 +292,10 @@ public:
* world communicator, keeping the same context.
*/
void CopyFrom(vtkMPICommunicator* source);
protected:
vtkMPICommunicator();
~vtkMPICommunicator();
//@}
// Obtain size and rank setting NumberOfProcesses and LocalProcessId Should
// not be called if the current communicator does not include this process
......
......@@ -337,15 +337,14 @@ protected:
static char ProcessorName[];
//@{