[vtk-developers] Doxygen macro

Utkarsh Ayachit utkarsh.ayachit at kitware.com
Thu Mar 22 12:37:43 EDT 2018


Indeed. Looks like DOXYGEN_SHOULD_SKIP_THIS should indeed be defined
in the doxyfile [1].

[1] https://www.stack.nl/~dimitri/doxygen/manual/faq.html#faq_code

On Thu, Mar 22, 2018 at 12:32 PM, David Gobbi <david.gobbi at gmail.com> wrote:
> Some of the uses of DOXYGEN_SHOULD_SKIP_THIS in VTK should probably be using
> @cond instead.  But it seems that DOXYGEN_SHOULD_SKIP_THIS was meant for
> larger blocks than @cond is typically used for (i.e. it's a bigger hammer
> than @cond).
>
>
>
> On Thu, Mar 22, 2018 at 10:11 AM, Utkarsh Ayachit
> <utkarsh.ayachit at kitware.com> wrote:
>>
>> Should have looked at the code; it's not being used the way I thought
>> it was (using a @cond). Please ignore my email :).
>>
>>
>>
>> On Thu, Mar 22, 2018 at 12:09 PM, Utkarsh Ayachit
>> <utkarsh.ayachit at kitware.com> wrote:
>> > David,
>> >
>> > That's how it should be if the intent is to skip generating doxygen
>> > code for those parts, isn't it?
>> >
>> > Utkarsh
>> >
>> > [1]
>> > https://stackoverflow.com/questions/1619577/how-can-doxygen-exclude-a-c-class
>> >
>> >
>> >
>> > On Thu, Mar 22, 2018 at 12:05 PM, David Gobbi <david.gobbi at gmail.com>
>> > wrote:
>> >> Hi All,
>> >>
>> >> I notice that a few headers check the macro DOXYGEN_SHOULD_SKIP_THIS,
>> >> but we
>> >> don't predefine this macro in VTK's doxygen.in file.  It's used
>> >> (currently
>> >> with no effect) in the following files:
>> >>
>> >> vtkSMPTools.h
>> >> vtkCachingInterpolatedVelocityField.h
>> >> vtkModifiedBSPTree.h
>> >>
>> >>  - David
>> >>
>> >>
>> >> _______________________________________________
>> >> Powered by www.kitware.com
>> >>
>> >> Visit other Kitware open-source projects at
>> >> http://www.kitware.com/opensource/opensource.html
>> >>
>> >> Search the list archives at:
>> >> http://markmail.org/search/?q=vtk-developers
>> >>
>> >> Follow this link to subscribe/unsubscribe:
>> >> https://vtk.org/mailman/listinfo/vtk-developers
>> >>
>> >>
>
>
>
> _______________________________________________
> Powered by www.kitware.com
>
> Visit other Kitware open-source projects at
> http://www.kitware.com/opensource/opensource.html
>
> Search the list archives at: http://markmail.org/search/?q=vtk-developers
>
> Follow this link to subscribe/unsubscribe:
> https://vtk.org/mailman/listinfo/vtk-developers
>
>


More information about the vtk-developers mailing list