[vtk-developers] Missing Doxygen for TextAnalysis classes

[David Doria]

On Tue, Jun 22, 2010 at 4:56 PM, David Doria <daviddoria+vtk at gmail.com> wrote:
> On Thu, May 27, 2010 at 1:05 PM, David Doria <daviddoria+vtk at gmail.com> wrote:
>> For several classes (vtkSelectArraySlices, vtkExtractArraySlices,
>> etc), the header that doxygen seems to have is incorrect. For example:
>>
>> http://www.vtk.org/doc/nightly/html/vtkSelectArraySlices_8h_source.html
>>
>> The documentation generated indeed matches that header, but that
>> header does not match the one in the repository (it is basically
>> empty).
>>
>> Anyone know why this may be happening?
>>
>> Thanks,
>>
>> David
>>
>
> Any thoughts on this?
>
> Thanks,
>
> David
>

I looked into this. For some reason, the #ifndef was BEFORE the class
description:

(like this)

----------------------------------------
#ifndef __vtkSelectArraySlices_h
#define __vtkSelectArraySlices_h

#include <vtkSelectionAlgorithm.h>

// .NAME vtkSelectArraySlices - Produces a selection based on array slice values
//
// Inputs:
//   Input port 0: (required) A vtkTypedArray<double> of any dimension.
//
// Outputs:
//   Output port 0: A vtkSelection containing the indices of each slice (along a
//     user-supplied dimension) that should be selected.
//
// .SECTION Thanks
// Developed by Timothy M. Shead (tshead at sandia.gov) at Sandia
National Laboratories.

class VTK_TEXT_ANALYSIS_EXPORT vtkSelectArraySlices :
  public vtkSelectionAlgorithm

----------------------------------------

I moved it to below the class description:

// .NAME vtkSelectArraySlices - Produces a selection based on array slice values
//
// Inputs:
//   Input port 0: (required) A vtkTypedArray<double> of any dimension.
//
// Outputs:
//   Output port 0: A vtkSelection containing the indices of each slice (along a
//     user-supplied dimension) that should be selected.
//
// .SECTION Thanks
// Developed by Timothy M. Shead (tshead at sandia.gov) at Sandia
National Laboratories.

#ifndef __vtkSelectArraySlices_h
#define __vtkSelectArraySlices_h

#include <vtkSelectionAlgorithm.h>

class VTK_TEXT_ANALYSIS_EXPORT vtkSelectArraySlices :
  public vtkSelectionAlgorithm

and rebuilt the doxygen and it creates the correct html. Any objects
to pushing these changes?

Thanks,

David