[vtk-developers] Doxygen for vtkArrayPrint (and similar cases)

[Timothy Shead]

On 8/30/10 6:34 PM, David Doria wrote:
> On Wed, Aug 25, 2010 at 8:18 PM, David Doria <daviddoria+vtk at gmail.com
> <mailto:daviddoria%2Bvtk at gmail.com>> wrote:
>
>     I came across a function called vtkPrintMatrixFormat. When I grep-ed
>     for it, I found that it was in vtkArrayPrint.h. When I searched this
>     page:
>     http://www.vtk.org/doc/nightly/html/classes.html
>
>     I was confused to not find vtkArrayPrint. It turns out it is because
>     there is no actual class called vtkArrayPrint, but rather the file
>     vtkArrayPrint.h has three functions in the global namespace. I think
>     these should still get included in the Doxygen.
>
>     I added
>
>     // .NAME vtkArrayPrint - Print arrays in different formats
>
>     to the top of the file and
>
>     /// \relates vtkArrayPrint
>
>     to the top of each function description. Doing this produces Doxygen
>     that looks reasonable to me. Any objections to doing this in this
>     type of situation?
>
>     Thanks,
>
>     David
>
>
> Any thoughts on this?
>
> David

Not my call, but it seems like a winner - I wasn't aware that there was 
VTK markup that would work with non-member functions.

Cheers,
Tim

-- 
Timothy M. Shead
Sandia National Laboratories
1424, Data Analysis and Visualization