[vtkusers] Documentation rules discussion
Jeff Baumes
jeff.baumes at kitware.com
Fri Nov 20 10:48:25 EST 2009
I think an appropriate way to comment is the following:
// Description:
// The minimum number of cells per spatial region. Default is 100.
vtkSetMacro(MinCells, int);
vtkGetMacro(MinCells, int);
It's much less cluttered and everything for describing the
parameter/getter/setter is in one place, so you don't need to change
things in multiple places. I agree that we need to do better at
documenting default values.
Jeff
More information about the vtkusers
mailing list