[vtkusers] Set vs Get comments + doxygen errors?

David Doria daviddoria+vtk at gmail.com
Thu Nov 12 10:17:56 EST 2009


Very commonly I find things like this:

  // Description:
  // Specify the average number of points in each bucket.
  vtkSetClampMacro(NumberOfPointsPerBucket,int,1,VTK_LARGE_INTEGER);
  vtkGetMacro(NumberOfPointsPerBucket,int);

Should these be more like the following?

  // Description:
  // Specify the average number of points in each bucket. A check is
performed to ensure the specified value is between 1 and
VTK_LARGE_INTEGER.
  vtkSetClampMacro(NumberOfPointsPerBucket,int,1,VTK_LARGE_INTEGER);

  // Description:
  // Get the average number of points in each bucket.
  vtkGetMacro(NumberOfPointsPerBucket,int);

Also, the doygen that gets generated seems to be inconsistent. This
one is correct:

virtual void vtkPointLocator::SetNumberOfPointsPerBucket (int)[virtual]
Specify the average number of points in each bucket.

But this one seems rogue:

virtual int vtkPointLocator::GetNumberOfPointsPerBucket(  )	[virtual]
Set the number of divisions in x-y-z directions.

Thoughts?

Thanks,

David



More information about the vtkusers mailing list