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

remove recursive header includes #314

Merged
merged 2 commits into from
Dec 18, 2021
Merged

Conversation

hjmjohnson
Copy link
Member

COMP: Remove inclusion of .hxx files as headers

The ability to include either .h or .hxx files as
header files required recursively reading the
.h files twice. The added complexity is
unnecessary, costly, and can confuse static
analysis tools that monitor header guardes (due
to reaching the maximum depth of recursion
limits for nested #ifdefs in checking).

The ability to include either .h or .hxx files as
header files required recursively reading the
.h files twice.  The added complexity is
unnecessary, costly, and can confuse static
analysis tools that monitor header guardes (due
to reaching the maximum depth of recursion
limits for nested #ifdefs in checking).
@hjmjohnson hjmjohnson self-assigned this Dec 17, 2021
@github-actions github-actions bot added area:Core Issues affecting the Core module area:Filtering Issues affecting the Filtering module language:C++ Changes to C++ examples labels Dec 17, 2021
@@ -1,7 +1,6 @@
#ifndef __itkImageFilter_hxx
#define __itkImageFilter_hxx

#include "ImageFilter.h"
Copy link
Member

Choose a reason for hiding this comment

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

Is a similar change needed in the software guide? If there are any instances of this, it is.

Copy link
Member

Choose a reason for hiding this comment

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

InsightSoftwareConsortium/ITKSoftwareGuide#171 for the coding style guidelines section.

@hjmjohnson hjmjohnson merged commit 28820f4 into master Dec 18, 2021
@jhlegarreta jhlegarreta deleted the remove-recursive-header-includes branch December 21, 2021 14:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:Core Issues affecting the Core module area:Filtering Issues affecting the Filtering module language:C++ Changes to C++ examples
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants