Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

COMP: Remove Doxygen \ref, \copydetails commands #263

Merged
merged 1 commit into from Dec 5, 2018

Conversation

thewtex
Copy link
Member

@thewtex thewtex commented Dec 4, 2018

Doxygen will implicitly pick up these references. Adding them explicitly
causes warnings in the Python wrapping, when their definition is not
available. Remove them also makes it a little easier to read the
comment.

To address:

/home/matt/src/ITK2/Modules/Core/Common/include/itkFloatingPointExceptions.h:50: warning: @copydetails or @copydoc target 'Enable' not found
/home/matt/src/ITK2/Modules/Core/Common/include/itkFloatingPointExceptions.h:61: warning: @copydetails or @copydoc target 'Enable' not found
[5864/6441] Building CXX object Wrapping/Modules/ITKColormap/CMakeFiles/ITKColormapPython.dir/itkScalarToRGBColormapImageFilterPython.cpp.o
/home/matt/src/ITK2/Modules/Filtering/FFT/include/itkForwardFFTImageFilter.h:44: warning: unable to resolve reference to `FrequencyFFTLayoutImageRegionConstIteratorWithIndex' for \ref command
/home/matt/src/ITK2/Modules/Filtering/FFT/include/itkForwardFFTImageFilter.h:46: warning: unable to resolve reference to `ITKImageFrequency' for \ref command
/home/matt/src/ITK2/Modules/Filtering/ImageFrequency/include/itkUnaryFrequencyDomainFilter.h:38: warning: unable to resolve reference to `FrequencyImageRegionIteratorWithIndex' for \ref command
/home/matt/src/ITK2/Modules/Filtering/ImageFrequency/include/itkUnaryFrequencyDomainFilter.h:42: warning: unable to resolve reference to `ForwardFFTImageFilter' for \ref command
/home/matt/src/ITK2/Modules/Filtering/ImageFrequency/include/itkUnaryFrequencyDomainFilter.h:43: warning: unable to resolve reference to `FrequencyFFTLayoutImageRegionIteratorWithIndex' for \ref command
/home/matt/src/ITK2/Modules/Filtering/ImageFrequency/include/itkUnaryFrequencyDomainFilter.h:44: warning: unable to resolve reference to `FrequencyFFTLayoutImageRegionIteratorWithIndex' for \ref command
/home/matt/src/ITK2/Modules/Filtering/ImageFrequency/include/itkUnaryFrequencyDomainFilter.h:48: warning: unable to resolve reference to `FrequencyHalfHermitianFFTLayoutImageRegionIteratorWithIndex' for \ref command
/home/matt/src/ITK2/Modules/Filtering/ImageFrequency/include/itkUnaryFrequencyDomainFilter.h:50: warning: unable to resolve reference to `FrequencyShiftedFFTLayoutImageRegionIteratorWithIndex' for \ref command

Doxygen will implicitly pick up these references. Adding them explicitly
causes warnings in the Python wrapping, when their definition is not
available. Remove them also makes it a little easier to read the
comment.

To address:

/home/matt/src/ITK2/Modules/Core/Common/include/itkFloatingPointExceptions.h:50: warning: @copydetails or @copydoc target 'Enable' not found
/home/matt/src/ITK2/Modules/Core/Common/include/itkFloatingPointExceptions.h:61: warning: @copydetails or @copydoc target 'Enable' not found
[5864/6441] Building CXX object Wrapping/Modules/ITKColormap/CMakeFiles/ITKColormapPython.dir/itkScalarToRGBColormapImageFilterPython.cpp.o
/home/matt/src/ITK2/Modules/Filtering/FFT/include/itkForwardFFTImageFilter.h:44: warning: unable to resolve reference to `FrequencyFFTLayoutImageRegionConstIteratorWithIndex' for \ref command
/home/matt/src/ITK2/Modules/Filtering/FFT/include/itkForwardFFTImageFilter.h:46: warning: unable to resolve reference to `ITKImageFrequency' for \ref command
/home/matt/src/ITK2/Modules/Filtering/ImageFrequency/include/itkUnaryFrequencyDomainFilter.h:38: warning: unable to resolve reference to `FrequencyImageRegionIteratorWithIndex' for \ref command
/home/matt/src/ITK2/Modules/Filtering/ImageFrequency/include/itkUnaryFrequencyDomainFilter.h:42: warning: unable to resolve reference to `ForwardFFTImageFilter' for \ref command
/home/matt/src/ITK2/Modules/Filtering/ImageFrequency/include/itkUnaryFrequencyDomainFilter.h:43: warning: unable to resolve reference to `FrequencyFFTLayoutImageRegionIteratorWithIndex' for \ref command
/home/matt/src/ITK2/Modules/Filtering/ImageFrequency/include/itkUnaryFrequencyDomainFilter.h:44: warning: unable to resolve reference to `FrequencyFFTLayoutImageRegionIteratorWithIndex' for \ref command
/home/matt/src/ITK2/Modules/Filtering/ImageFrequency/include/itkUnaryFrequencyDomainFilter.h:48: warning: unable to resolve reference to `FrequencyHalfHermitianFFTLayoutImageRegionIteratorWithIndex' for \ref command
/home/matt/src/ITK2/Modules/Filtering/ImageFrequency/include/itkUnaryFrequencyDomainFilter.h:50: warning: unable to resolve reference to `FrequencyShiftedFFTLayoutImageRegionIteratorWithIndex' for \ref command
Copy link
Contributor

@jcfr jcfr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this will be consistent with how other classes are referenced in other classes 👍

Also the copy detail is not needed, as there are \sa ...

Copy link
Contributor

@phcerdan phcerdan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good to know, thanks @thewtex 👍

@thewtex thewtex merged commit 8e3d08d into InsightSoftwareConsortium:master Dec 5, 2018
@thewtex thewtex deleted the doxygen-warnings branch December 5, 2018 00:41
@hjmjohnson hjmjohnson mentioned this pull request Dec 5, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants