[vtkusers] Documentation rules discussion

[Thompson, David C]

> 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.

If we ever get a property mechanism for VTK, it would be easy
to document the default values automatically since we could
create an instance of each object and query each property for
its value... This is one of the reasons I voted for introspection
support at vtk.uservoice.com.

    David