Commit 24f5fe45 authored by luzpaz's avatar luzpaz Committed by Ben Boeckel

Misc. doxy and comment typo fixes

parent a2326365
......@@ -354,7 +354,7 @@ public:
/**
* Enable model post process on output
* Return true if sucessful, false otherwise
* Return true if successful, false otherwise
* Empty and Always return true with basic model
*/
virtual bool FinalizeOutputs(vtkPolyData* vtkNotUsed(particlePathsOutput),
......
......@@ -398,7 +398,7 @@ public:
/**
* Convienience setter for integration time,
* do not use unless manual particle shifting
* One using this method may want ot consider
* One using this method may want to consider
* modifing EquationVariable[numVals] which
* contain integrationTime as well,
* if it matters in their model.
......
......@@ -129,7 +129,7 @@ int vtkDeformPointSet::RequestData(
outPts->SetNumberOfPoints(numberOfPointSetPoints);
output->SetPoints(outPts);
// Start by determing whether weights must be computed or not
// Start by determining whether weights must be computed or not
int abort=0;
vtkIdType progressInterval=(numberOfPointSetPoints/10 + 1);
int workLoad=1;
......
......@@ -2502,7 +2502,7 @@ void vtkDataSetSurfaceFilter::InitFastGeomQuadAllocation(vtkIdType numberOfCells
// This should be plenty (unless we have triangle strips) ...
this->NumberOfFastGeomQuadArrays = 100;
this->FastGeomQuadArrays = new unsigned char*[this->NumberOfFastGeomQuadArrays];
// Initalize all to nullptr;
// Initialize all to nullptr;
for (idx = 0; idx < this->NumberOfFastGeomQuadArrays; ++idx)
{
this->FastGeomQuadArrays[idx] = nullptr;
......
......@@ -48,7 +48,7 @@ public:
* into a single Sample
* The number of arrays will determine the number of components of
* the Sample.
* Arrays are suposed to have the same number of tuples, and the
* Arrays are supposed to have the same number of tuples, and the
* Sample will also have the same number of tuples.
* This method allocate a new Sample and returns it,
* so it is caller's responsibility to delete it with the delete operator.
......
......@@ -1436,7 +1436,7 @@ void vtkPStructuredGridConnectivity::SerializeGridExtents(
int *&sndbuffer, vtkIdType &N )
{
assert( "pre: Instance has not been initialized!" && this->Initialized );
assert( "pre: send buffer is expected ot be nullptr" && sndbuffer == nullptr );
assert( "pre: send buffer is expected to be nullptr" && sndbuffer == nullptr );
//Each local extent is serialized with 7 ints:ID imin imax jmin jmax kmin kmax
N = this->GetNumberOfLocalGrids()*7;
......
......@@ -227,7 +227,7 @@ protected:
virtual vtkIdType GetTotalNumberOfObservations( vtkIdType numObservations );
/**
* Subroutine to initalize the cluster centers using those provided by the user
* Subroutine to initialize the cluster centers using those provided by the user
* in input port LEARN_PARAMETERS. If no cluster centers are provided, the subroutine uses the
* first DefaultNumberOfClusters input data points as initial cluster centers.
* Called from within Learn.
......
......@@ -33,7 +33,7 @@ class TestSortFileNames(vtk.test.Testing.vtkTest):
globFileNames = vtk.vtkGlobFileNames()
# globs do not include Kleene star support for patern repetitions thus
# globs do not include Kleene star support for pattern repetitions thus
# we insert a pattern for both single and double digit file extensions.
globFileNames.AddFileNames(VTK_DATA_ROOT + "/Data/headsq/quarter.[1-9]")
globFileNames.AddFileNames(VTK_DATA_ROOT + "/Data/headsq/quarter.[1-9][0-9]")
......
......@@ -2,7 +2,7 @@ package require vtk
vtkGlobFileNames globFileNames
globFileNames SetDirectory "$VTK_DATA_ROOT/Data/"
# globs do not include Kleene star support for patern repetitions thus
# globs do not include Kleene star support for pattern repetitions thus
# we insert a pattern for both single and double digit file extensions.
globFileNames AddFileNames "headsq/quarter.\[1\-9\]"
globFileNames AddFileNames "headsq/quarter.\[1\-9\]\[0\-9\]"
......
......@@ -2,7 +2,7 @@ package require vtk
vtkGlobFileNames globFileNames
# globs do not include Kleene star support for patern repetitions thus
# globs do not include Kleene star support for pattern repetitions thus
# we insert a pattern for both single and double digit file extensions.
globFileNames AddFileNames "$VTK_DATA_ROOT/Data/headsq/quarter.\[1\-9\]"
globFileNames AddFileNames "$VTK_DATA_ROOT/Data/headsq/quarter.\[1\-9\]\[0\-9\]"
......
......@@ -3869,7 +3869,7 @@ int vtkExodusIIReaderPrivate::OpenFile( const char* filename )
this->Exoid = ex_open( filename, EX_READ,
&this->AppWordSize, &this->DiskWordSize, &this->ExodusVersion );
// figure out the longest string name we have and then set that to be the
// maximum length for the variable names. This is called everytime that the reader
// maximum length for the variable names. This is called every time that the reader
// is updated so we don't have to worry about setting the global max_name_length variable.
// this is because in our current version of the ExodusII libraries the exo Id isn't used
// in the ex_set_max_name_length() function.
......
......@@ -164,7 +164,7 @@ void vtkMPIImageReader::PartitionController(const int extent[6])
if ((this->GetFileDimensionality() == 3) || (numZ == 1))
{
// Everyone reads from the same single file. No need to partion controller.
// Everyone reads from the same single file. No need to partition controller.
this->SetGroupedController(this->Controller);
return;
}
......@@ -435,7 +435,7 @@ void vtkMPIImageReader::ExecuteDataWithInformation(vtkDataObject *output,
this->Transform = newTransform;
}
// Get information on data partion requested.
// Get information on data partition requested.
int inExtent[6];
vtkIdType inIncrements[3];
data->GetExtent(inExtent);
......
......@@ -176,7 +176,7 @@ void vtkPNrrdReader::PartitionController(const int extent[6])
if ((this->GetFileDimensionality() == 3) || (numZ == 1))
{
// Everyone reads from the same single file. No need to partion controller.
// Everyone reads from the same single file. No need to partition controller.
this->SetGroupedController(this->Controller);
return;
}
......@@ -448,7 +448,7 @@ void vtkPNrrdReader::ExecuteDataWithInformation(vtkDataObject *output,
this->Transform = newTransform;
}
// Get information on data partion requested.
// Get information on data partition requested.
int inExtent[6];
vtkIdType inIncrements[3];
data->GetExtent(inExtent);
......
......@@ -496,7 +496,7 @@ SplatPoints(vtkCheckerboardSplatter *self, vtkIdType npts, TPoints *pts,
// total colors / groups). Because the checkerboard dimensions are a
// multiple of two, the total number of all colors of squares is divisible
// by 8. Also set up offsets for each color / group which is used in
// determing addresses and later processing.
// determining addresses and later processing.
algo.NSquares = algo.BDims[0]*algo.BDims[1]*algo.BDims[2];
for (i=0; i<9; ++i)
{
......
......@@ -404,7 +404,7 @@ void vtkSliceCubes::Execute()
double xmin[3], xmax[3];
double origin[3], Spacing[3];
// check input/initalize
// check input/initialize
vtkDebugMacro(<< "Executing slice cubes");
if ( this->Reader == nullptr )
{
......
......@@ -202,7 +202,7 @@ public:
//@}
/**
* State is either outside, or inside (on the text portion ot the image).
* State is either outside, or inside (on the text portion of the image).
*/
enum _InteractionState {Outside=0, OnText, OnImage};
......
......@@ -48,7 +48,7 @@ public:
//@{
/**
* Standar VTK class methods.
* Standard VTK class methods.
*/
vtkTypeMacro(vtkCameraWidget,vtkBorderWidget);
void PrintSelf(ostream& os, vtkIndent indent) override;
......
......@@ -41,7 +41,7 @@
* \par
* So why maintain the display position? Consider drawing a contour on a
* volume widget. You might want the contour to be located at a certain world
* position in the volume or you might want to be overlayed over the window
* position in the volume or you might want to be overlaid over the window
* like an Actor2D. The default behaviour of this class is to provide the
* former behaviour.
*
......
......@@ -20,7 +20,7 @@
*
* The contour will stay on the focal plane irrespective of camera
* position/orientation changes. The class was written in order to be able to
* draw contours on a volume widget and have the contours overlayed on the
* draw contours on a volume widget and have the contours overlaid on the
* focal plane in order to do contour segmentation. The superclass,
* vtkContourRepresentation handles contours that are drawn in actual world
* position co-ordinates, so they would rotate with the camera position/
......
......@@ -45,7 +45,7 @@ public:
//@{
/**
* Standar VTK class methods.
* Standard VTK class methods.
*/
vtkTypeMacro(vtkLogoWidget,vtkBorderWidget);
void PrintSelf(ostream& os, vtkIndent indent) override;
......
......@@ -658,7 +658,7 @@ vtkMatrix4x4 * vtkOrientedGlyphFocalPlaneContourRepresentation
//----------------------------------------------------------------------
// Returns the contour representation as polydata in world co-ordinates
// For this class, the contour is overlayed on the focal plane.
// For this class, the contour is overlaid on the focal plane.
//
vtkPolyData * vtkOrientedGlyphFocalPlaneContourRepresentation
::GetContourRepresentationAsPolyData()
......
......@@ -19,9 +19,9 @@
*
*
* This class is used to represent a contour drawn on the focal plane (usually
* overlayed on top of an image or volume widget).
* overlaid on top of an image or volume widget).
* The class was written in order to be able to draw contours on a volume widget
* and have the contours overlayed on the focal plane in order to do contour
* and have the contours overlaid on the focal plane in order to do contour
* segmentation.
*
* @sa
......
......@@ -44,7 +44,7 @@ public:
//@{
/**
* Standar VTK class methods.
* Standard VTK class methods.
*/
vtkTypeMacro(vtkPlaybackWidget,vtkBorderWidget);
void PrintSelf(ostream& os, vtkIndent indent) override;
......
......@@ -40,7 +40,7 @@
* <pre>
* If the handle or sphere are selected:
* LeftButtonPressEvent - select the handle or sphere
* LeftButtonReleaseEvent - release the handle ot sphere
* LeftButtonReleaseEvent - release the handle to sphere
* MouseMoveEvent - move the handle or translate the sphere
* In all the cases, independent of what is picked, the widget responds to the
* following VTK events:
......
......@@ -264,7 +264,7 @@ public:
//@{
/**
* Get/Set the alignement of the title related to the axis.
* Get/Set the alignment of the title related to the axis.
* Possible Alignment: VTK_ALIGN_TOP, VTK_ALIGN_BOTTOM, VTK_ALIGN_POINT1, VTK_ALIGN_POINT2
*/
virtual void SetTitleAlignLocation(int location);
......@@ -700,13 +700,13 @@ protected:
int TickLocation;
/**
* Hold the alignement property of the title related to the axis.
* Hold the alignment property of the title related to the axis.
* Possible Alignment: VTK_ALIGN_BOTTOM, VTK_ALIGN_TOP, VTK_ALIGN_POINT1, VTK_ALIGN_POINT2.
*/
int TitleAlignLocation;
/**
* Hold the alignement property of the exponent coming from the label values.
* Hold the alignment property of the exponent coming from the label values.
* Possible Alignment: VTK_ALIGN_BOTTOM, VTK_ALIGN_TOP, VTK_ALIGN_POINT1, VTK_ALIGN_POINT2.
*/
int ExponentLocation;
......
......@@ -549,7 +549,7 @@ public:
//@{
/**
* Provide a custom AxisOrigin. This point must be inside the bouding box and
* Provide a custom AxisOrigin. This point must be inside the bounding box and
* will represent the point where the 3 axes will interesect
*/
vtkSetVector3Macro(AxisOrigin,double);
......
......@@ -331,7 +331,7 @@ public:
//@{
/**
* Get/Set the alignement of the radial axes title related to the axis.
* Get/Set the alignment of the radial axes title related to the axis.
* Possible Alignment: VTK_TITLE_BOTTOM, VTK_TITLE_EXTERN
*/
vtkSetClampMacro(RadialAxisTitleLocation, int, VTK_TITLE_BOTTOM, VTK_TITLE_EXTERN);
......@@ -340,7 +340,7 @@ public:
//@{
/**
* Get/Set the alignement of the polar axes title related to the axis.
* Get/Set the alignment of the polar axes title related to the axis.
* Possible Alignment: VTKTITLE_BOTTOM, VTK_TITLE_EXTERN
*/
vtkSetClampMacro(PolarAxisTitleLocation, int, VTK_TITLE_BOTTOM, VTK_TITLE_EXTERN);
......@@ -1056,12 +1056,12 @@ protected:
//@}
/**
* Define the alignement of the title related to the radial axis. (BOTTOM or EXTERN)
* Define the alignment of the title related to the radial axis. (BOTTOM or EXTERN)
*/
int RadialAxisTitleLocation;
/**
* Define the alignement of the title related to the polar axis. (BOTTOM or EXTERN)
* Define the alignment of the title related to the polar axis. (BOTTOM or EXTERN)
*/
int PolarAxisTitleLocation;
......
......@@ -315,7 +315,7 @@ public:
/**
* Helper method to go from a enum subtype to a string subtype
* The difference from GetStringFromSubType is that it returns
* a shorter strings (useful for GUI with minimun space)
* a shorter strings (useful for GUI with minimum space)
*/
static const char *GetShortStringFromSubType(int subtype);
......
......@@ -102,7 +102,7 @@ public:
vtkTypeUInt64 ElapsedTimeNanoseconds() const
{ return this->EndTime - this->StartTime; }
/** Child events that occured while this event was running. */
/** Child events that occurred while this event was running. */
std::vector<Event> Events;
/** Print details of the event to a stream.
......
......@@ -560,7 +560,7 @@ public:
//@{
/**
* Set/get the tranlation for pan/swipe gestures, update LastTranslation
* Set/get the translation for pan/swipe gestures, update LastTranslation
*/
void SetTranslation(double val[2]);
vtkGetVector2Macro(Translation, double);
......
......@@ -246,7 +246,7 @@ public:
//@{
/**
* Set/get the tranlation for pan/swipe gestures, update LastTranslation
* Set/get the translation for pan/swipe gestures, update LastTranslation
*/
void SetTranslation3D(double val[3]);
vtkGetVector3Macro(Translation3D, double);
......
......@@ -564,7 +564,7 @@ int vtkTextActor::GetAlignmentPoint()
// ----------------------------------------------------------------------------
void vtkTextActor::SetAlignmentPoint(int val)
{
vtkWarningMacro(<< "Alignment point is being depricated. You should use "
vtkWarningMacro(<< "Alignment point is being deprecated. You should use "
<< "SetJustification and SetVerticalJustification in the text property.");
switch (val)
......
......@@ -137,7 +137,7 @@ public:
//@{
/**
* This method is being depricated. Use SetJustification and
* This method is being deprecated. Use SetJustification and
* SetVerticalJustification in text property instead.
* Set/Get the Alignment point
* if zero (default), the text aligns itself to the bottom left corner
......
......@@ -12,7 +12,7 @@
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
// This test verifies that light emmitting objects work in ospray's path tracer.
// This test verifies that light emitting objects work in ospray's path tracer.
//
// The command line arguments are:
// -I => run in interactive mode; unless this is used, the program will
......
......@@ -27,7 +27,7 @@
* called VTKOSPRAY_ARGS where commandline flags can be inserted for
* OSPRay's init call. As an example of this, below is a commandline
* for running paraview on localhost, but having OSPRay's rendering
* occur on 2 remote nodes. ospray_mpi_worker is a seperate application
* occur on 2 remote nodes. ospray_mpi_worker is a separate application
* supplied with OSPRay binary packages or when built with MPI support
* from source.
* 'mpirun -ppn 1 -hosts localhost VTKOSPRAY_ARGS="-osp:mpi"
......
......@@ -154,7 +154,7 @@ public:
/**
* Set this RenderWindow's window id to a pre-existing window.
* The paramater is an ASCII string of a decimal number representing
* The parameter is an ASCII string of a decimal number representing
* a pointer to the window.
*/
void SetWindowInfo(char*) override;
......
......@@ -1491,7 +1491,7 @@ void vtkCocoaRenderWindow::SetCocoaManager(void *manager)
//----------------------------------------------------------------------------
void vtkCocoaRenderWindow::SetWindowInfo(char *info)
{
// The paramater is an ASCII string of a decimal number representing
// The parameter is an ASCII string of a decimal number representing
// a pointer to the window. Convert it back to a pointer.
ptrdiff_t tmp = 0;
if (info)
......@@ -1505,7 +1505,7 @@ void vtkCocoaRenderWindow::SetWindowInfo(char *info)
//----------------------------------------------------------------------------
void vtkCocoaRenderWindow::SetParentInfo(char *info)
{
// The paramater is an ASCII string of a decimal number representing
// The parameter is an ASCII string of a decimal number representing
// a pointer to the window. Convert it back to a pointer.
ptrdiff_t tmp = 0;
if (info)
......
......@@ -155,7 +155,7 @@ public:
/**
* Set this RenderWindow's window id to a pre-existing window.
* The paramater is an ASCII string of a decimal number representing
* The parameter is an ASCII string of a decimal number representing
* a pointer to the window.
*/
void SetWindowInfo(char*) override;
......
......@@ -1481,7 +1481,7 @@ void vtkCocoaRenderWindow::SetCocoaManager(void *manager)
//----------------------------------------------------------------------------
void vtkCocoaRenderWindow::SetWindowInfo(char *info)
{
// The paramater is an ASCII string of a decimal number representing
// The parameter is an ASCII string of a decimal number representing
// a pointer to the window. Convert it back to a pointer.
ptrdiff_t tmp = 0;
if (info)
......@@ -1495,7 +1495,7 @@ void vtkCocoaRenderWindow::SetWindowInfo(char *info)
//----------------------------------------------------------------------------
void vtkCocoaRenderWindow::SetParentInfo(char *info)
{
// The paramater is an ASCII string of a decimal number representing
// The parameter is an ASCII string of a decimal number representing
// a pointer to the window. Convert it back to a pointer.
ptrdiff_t tmp = 0;
if (info)
......
......@@ -154,7 +154,7 @@ public:
/**
* Set this RenderWindow's window id to a pre-existing window.
* The paramater is an ASCII string of a decimal number representing
* The parameter is an ASCII string of a decimal number representing
* a pointer to the window.
*/
void SetWindowInfo(char*) override;
......
......@@ -544,7 +544,7 @@ void *vtkIOSRenderWindow::GetPixelFormat()
//----------------------------------------------------------------------------
void vtkIOSRenderWindow::SetWindowInfo(char *info)
{
// The paramater is an ASCII string of a decimal number representing
// The parameter is an ASCII string of a decimal number representing
// a pointer to the window. Convert it back to a pointer.
ptrdiff_t tmp = 0;
if (info)
......@@ -558,7 +558,7 @@ void vtkIOSRenderWindow::SetWindowInfo(char *info)
//----------------------------------------------------------------------------
void vtkIOSRenderWindow::SetParentInfo(char *info)
{
// The paramater is an ASCII string of a decimal number representing
// The parameter is an ASCII string of a decimal number representing
// a pointer to the window. Convert it back to a pointer.
ptrdiff_t tmp = 0;
if (info)
......
......@@ -33,7 +33,7 @@
/**
* The following functions can be used to detect and report, and/or
* silently clear OpenGL error flags. These are not intended to be
* used driectly, instead use the following macros.
* used directly, instead use the following macros.
*
* vtkOpenGLClearErrorMacro() -- Silently clear OpenGL error flags.
*
......
......@@ -25,7 +25,7 @@
* This uses GL_TIMESTAMP rather than GL_ELAPSED_TIME, since only one
* GL_ELAPSED_TIME query may be active at a time. Since GL_TIMESTAMP is not
* available on OpenGL ES, timings will not be available on those platforms.
* Use the static IsSupported() method to determine if the timer is availble.
* Use the static IsSupported() method to determine if the timer is available.
*/
#ifndef vtkOpenGLRenderTimer_h
......
......@@ -125,7 +125,7 @@ int vtkOpenVRPropPicker::PickProp3DRay(
//If we pick inside a prop, it will be returned only if no other vtkProps are
//intersected by the ray. WARNING: Intersection checking uses bounds. This is
//confusing when the prop isn't fully filling its bounds. Improve this by :
//-returning the prop wich bounds center is the closest to the ray, or
//-returning the prop which bounds center is the closest to the ray, or
//-computing intersection with the geometry itself (see vtkCellPicker).
for (propCollection->InitTraversal(pit);
(prop = propCollection->GetNextProp(pit));)
......
......@@ -28,7 +28,7 @@
* event, it's start and end times, and its ellapsed time.
* EndEventSynch includes a barrier before the measurement.
*
* The log class implements the singleton patern so that it
* The log class implements the singleton pattern so that it
* may be shared across class boundaries. If the log instance
* doesn't exist then one is created. It will be automatically
* destroyed at exit by the signleton destructor. It can be
......@@ -160,7 +160,7 @@ public:
int Write();
/**
* The log class implements the singleton patern so that it
* The log class implements the singleton pattern so that it
* may be shared across class boundaries. If the log instance
* doesn't exist then one is created. It will be automatically
* destroyed at exit by the signleton destructor. It can be
......
......@@ -413,7 +413,7 @@ bool vtkAMRVolumeMapper::ComputeResamplerBoundsFrustumMethod(
{
vtkMath::UninitializeBounds(out_bounds);
// First we need to create a bouding box that represents the visible region
// First we need to create a bounding box that represents the visible region
// of the camera in World Coordinates
// In order to produce as tight of bounding box as possible we need to determine
......
......@@ -332,7 +332,7 @@ protected:
// focal point
double LastFocalPointPosition[3];
double LastPostionFPDistance;
// This is used when determing if
// This is used when determining if
// either the camera or focal point has
// move enough to cause the resampler to update
double ResamplerUpdateTolerance;
......
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