Skip to content

Commit

Permalink
DOC: Fix unbalanced grouping commands Doxygen warnings
Browse files Browse the repository at this point in the history
Fix unbalanced grouping commands Doxygen warnings.

Fixes:
```
Modules/Core/Common/include/itkAutoPointer.h:261: warning: unbalanced grouping commands
```

warnings across classes.

The warning is raised when the
Utilities/Doxygen/itkdoxygen.pl

Doxygen Perl script processes the files at issue and starts a `/**@{`
block that gets interrupted by an unexpected symbol (e.g. a brace)
without being previously closed with the corresponding `/**@}*/`
ending token.

Raised for example in:
https://open.cdash.org/viewBuildError.php?type=1&buildid=8344134
  • Loading branch information
jhlegarreta committed Dec 19, 2022
1 parent 935533f commit 4293d83
Show file tree
Hide file tree
Showing 78 changed files with 104 additions and 2 deletions.
1 change: 1 addition & 0 deletions Modules/Core/Common/include/itkAutoPointer.h
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,7 @@ TransferAutoPointer(TAutoPointerBase & pa, TAutoPointerDerived & pb)
pb.ReleaseOwnership(); // pb Release Ownership and clears
}
}

} // end namespace itk

#endif
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,7 @@ class ITK_TEMPLATE_EXPORT BSplineDerivativeKernelFunction : public KernelFunctio
itkGenericExceptionMacro("Evaluate not implemented for spline order " << SplineOrder);
}
};

} // end namespace itk

#endif
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,7 @@ class ITK_TEMPLATE_EXPORT BSplineInterpolationWeightFunction
return table;
}() };
};

} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
Expand Down
1 change: 1 addition & 0 deletions Modules/Core/Common/include/itkBSplineKernelFunction.h
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,7 @@ class ITK_TEMPLATE_EXPORT BSplineKernelFunction : public KernelFunctionBase<TRea
itkGenericExceptionMacro("Evaluate not implemented for spline order " << SplineOrder);
}
};

} // end namespace itk

#endif
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ class ITK_TEMPLATE_EXPORT BackwardDifferenceOperator : public NeighborhoodOperat
this->FillCenteredDirectional(coeff);
}
};

} // namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,7 @@ class BufferedImageNeighborhoodPixelAccessPolicy final
{
m_NeighborhoodAccessor.Set(imageBufferPointer + m_PixelIndexValue, pixelValue);
}

};

} // namespace itk
Expand Down
1 change: 1 addition & 0 deletions Modules/Core/Common/include/itkCommonEnums.h
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,7 @@ using IOFileModeType = CommonEnums::IOFileMode;
using IOByteOrderType = CommonEnums::IOByteOrder;
using CellGeometryType = CommonEnums::CellGeometry;
#endif

// Define how to print enumeration
extern ITKCommon_EXPORT std::ostream &
operator<<(std::ostream & out, IOPixelEnum value);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ namespace itk
* \ingroup ImageIterators
* \ingroup ITKCommon
*/

template <unsigned int VImageDimension>
class ConnectedImageNeighborhoodShape
{
Expand Down Expand Up @@ -257,8 +258,8 @@ class ConnectedImageNeighborhoodShape
{
return (includeCenterPixel ? 1 : 0) + CalculateNumberOfConnectedNeighbors(maximumCityblockDistance);
}
};

};

/** Generates the offsets for a connected image neighborhood shape. */
template <unsigned int VImageDimension, size_t VMaximumCityblockDistance, bool VIncludeCenterPixel>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -144,8 +144,8 @@ class ConstantBoundaryImageNeighborhoodPixelAccessPolicy final
m_NeighborhoodAccessor.Set(imageBufferPointer + m_PixelIndexValue, pixelValue);
}
}
};

};

} // namespace itk

Expand Down
1 change: 1 addition & 0 deletions Modules/Core/Common/include/itkContinuousIndex.h
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ class ITK_TEMPLATE_EXPORT ContinuousIndex : public Point<TCoordRep, VIndexDimens
(*this)[i] = static_cast<TCoordRep>(index[i]);
}
}

};
} // namespace itk

Expand Down
1 change: 1 addition & 0 deletions Modules/Core/Common/include/itkCovariantVector.h
Original file line number Diff line number Diff line change
Expand Up @@ -254,6 +254,7 @@ class ITK_TEMPLATE_EXPORT CovariantVector : public FixedArray<T, VVectorDimensio
(*this)[i] = static_cast<T>(pa[i]);
}
}

};

/** Premultiply Operator for product of a vector and a scalar.
Expand Down
1 change: 1 addition & 0 deletions Modules/Core/Common/include/itkDefaultConvertPixelTraits.h
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ class ITK_TEMPLATE_EXPORT DefaultConvertPixelTraits
{
return pixel.GetScalarValue();
}

};

#define ITK_DEFAULTCONVERTTRAITS_NATIVE_SPECIAL(type) \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,7 @@ class ITK_TEMPLATE_EXPORT ExtractImageFilterRegionCopier : public ImageRegionCop
{
ImageRegionCopier<T1, T2>::operator()(destRegion, srcRegion);
}

};
} // end namespace ImageToImageFilterDetail
} // end namespace itk
Expand Down
1 change: 1 addition & 0 deletions Modules/Core/Common/include/itkFixedArray.h
Original file line number Diff line number Diff line change
Expand Up @@ -426,6 +426,7 @@ class ITK_TEMPLATE_EXPORT FixedArray
{
return MakeFilled<FixedArray>(value);
}

};

template <typename TValue, unsigned int VLength>
Expand Down
1 change: 1 addition & 0 deletions Modules/Core/Common/include/itkForwardDifferenceOperator.h
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ class ITK_TEMPLATE_EXPORT ForwardDifferenceOperator : public NeighborhoodOperato
{
this->FillCenteredDirectional(coeff);
}

};
} // namespace itk

Expand Down
1 change: 1 addition & 0 deletions Modules/Core/Common/include/itkImageIterator.h
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,7 @@ class ITK_TEMPLATE_EXPORT ImageIterator : public ImageConstIterator<TImage>
ImageIterator(const ImageConstIterator<TImage> & it);
Self &
operator=(const ImageConstIterator<TImage> & it);

};
} // end namespace itk

Expand Down
1 change: 1 addition & 0 deletions Modules/Core/Common/include/itkImageIteratorWithIndex.h
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,7 @@ class ITK_TEMPLATE_EXPORT ImageIteratorWithIndex : public ImageConstIteratorWith
ImageIteratorWithIndex(const ImageConstIteratorWithIndex<TImage> & it);
Self &
operator=(const ImageConstIteratorWithIndex<TImage> & it);

};
} // end namespace itk

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ class ITK_TEMPLATE_EXPORT ImageLinearIteratorWithIndex : public ImageLinearConst
ImageLinearIteratorWithIndex(const ImageLinearConstIteratorWithIndex<TImage> & it);
Self &
operator=(const ImageLinearConstIteratorWithIndex<TImage> & it);

};
} // end namespace itk

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ class ITK_TEMPLATE_EXPORT ImageRandomIteratorWithIndex : public ImageRandomConst
ImageRandomIteratorWithIndex(const ImageRandomConstIteratorWithIndex<TImage> & it);
Self &
operator=(const ImageRandomConstIteratorWithIndex<TImage> & it);

};
} // end namespace itk

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,7 @@ class ITK_TEMPLATE_EXPORT ImageRandomNonRepeatingIteratorWithIndex
ImageRandomNonRepeatingIteratorWithIndex(const ImageRandomNonRepeatingConstIteratorWithIndex<TImage> & it);
Self &
operator=(const ImageRandomNonRepeatingConstIteratorWithIndex<TImage> & it);

};
} // end namespace itk

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,7 @@ class ITK_TEMPLATE_EXPORT ImageRegionConstIteratorWithIndex : public ImageConstI
* \sa operator++ */
Self &
operator--();

};
} // end namespace itk

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,7 @@ class ITK_TEMPLATE_EXPORT ImageRegionConstIteratorWithOnlyIndex : public ImageCo
* \sa operator++ */
Self &
operator--();

};
} // end namespace itk

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,7 @@ class ITK_TEMPLATE_EXPORT ImageRegionExclusionIteratorWithIndex
ImageRegionExclusionIteratorWithIndex(const ImageRegionExclusionConstIteratorWithIndex<TImage> & it);
Self &
operator=(const ImageRegionExclusionConstIteratorWithIndex<TImage> & it);

};
} // end namespace itk

Expand Down
1 change: 1 addition & 0 deletions Modules/Core/Common/include/itkImageRegionIterator.h
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@ class ITK_TEMPLATE_EXPORT ImageRegionIterator : public ImageRegionConstIterator<
ImageRegionIterator(const ImageRegionConstIterator<TImage> & it);
Self &
operator=(const ImageRegionConstIterator<TImage> & it);

};
} // end namespace itk

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,7 @@ class ITK_TEMPLATE_EXPORT ImageRegionIteratorWithIndex : public ImageRegionConst
ImageRegionIteratorWithIndex(const ImageRegionConstIteratorWithIndex<TImage> & it);
Self &
operator=(const ImageRegionConstIteratorWithIndex<TImage> & it);

};
} // end namespace itk

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,7 @@ class ITK_TEMPLATE_EXPORT ImageRegionReverseIterator : public ImageRegionReverse
ImageRegionReverseIterator(const ImageRegionReverseConstIterator<TImage> & it);
Self &
operator=(const ImageRegionReverseConstIterator<TImage> & it);

};
} // end namespace itk

Expand Down
1 change: 1 addition & 0 deletions Modules/Core/Common/include/itkImageReverseIterator.h
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,7 @@ class ITK_TEMPLATE_EXPORT ImageReverseIterator : public ImageRegionReverseConstI
ImageReverseIterator(const ImageRegionReverseConstIterator<TImage> & it);
Self &
operator=(const ImageRegionReverseConstIterator<TImage> & it);

};
} // end namespace itk

Expand Down
1 change: 1 addition & 0 deletions Modules/Core/Common/include/itkImageScanlineIterator.h
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@ class ITK_TEMPLATE_EXPORT ImageScanlineIterator : public ImageScanlineConstItera
ImageScanlineIterator(const ImageScanlineConstIterator<TImage> & it);
Self &
operator=(const ImageScanlineConstIterator<TImage> & it);

};
} // end namespace itk

Expand Down
1 change: 1 addition & 0 deletions Modules/Core/Common/include/itkImageSink.h
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,7 @@ class ImageSink
*/
double m_CoordinateTolerance{ Self::GetGlobalDefaultCoordinateTolerance() };
double m_DirectionTolerance{ Self::GetGlobalDefaultDirectionTolerance() };

};

} // namespace itk
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,7 @@ class ITK_TEMPLATE_EXPORT ImageSliceIteratorWithIndex : public ImageSliceConstIt
ImageSliceIteratorWithIndex(const ImageSliceConstIteratorWithIndex<TImage> & it);
Self &
operator=(const ImageSliceConstIteratorWithIndex<TImage> & it);

};
} // end namespace itk

Expand Down
11 changes: 11 additions & 0 deletions Modules/Core/Common/include/itkMemoryUsageObserver.h
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,10 @@ class ITKCommon_EXPORT LinuxMemoryUsageObserver : public MemoryUsageObserverBase
public:
/** destructor */
~LinuxMemoryUsageObserver() override;

MemoryLoadType
GetMemoryUsage() override;

};
#endif // __linux__

Expand All @@ -98,8 +100,10 @@ class ITKCommon_EXPORT MacOSXMemoryUsageObserver : public MemoryUsageObserverBas
public:
/** destructor */
~MacOSXMemoryUsageObserver() override;

MemoryLoadType
GetMemoryUsage() override;

};
#endif // Mac OS X

Expand All @@ -109,8 +113,10 @@ class ITKCommon_EXPORT SunSolarisMemoryUsageObserver : public MemoryUsageObserve
public:
/** destructor */
virtual ~SunSolarisMemoryUsageObserver();

virtual MemoryLoadType
GetMemoryUsage();

};
#endif // Sun Solaris

Expand All @@ -120,8 +126,10 @@ class ITKCommon_EXPORT SysResourceMemoryUsageObserver : public MemoryUsageObserv
public:
/** destructor */
~SysResourceMemoryUsageObserver() override;

MemoryLoadType
GetMemoryUsage() override;

};

# if defined(ITK_HAS_MALLINFO) || defined(ITK_HAS_MALLINFO2)
Expand All @@ -134,9 +142,12 @@ class ITKCommon_EXPORT MallinfoMemoryUsageObserver : public MemoryUsageObserverB
public:
/** destructor */
~MallinfoMemoryUsageObserver() override;

MemoryLoadType
GetMemoryUsage() override;

};

# endif // Mallinfo
#endif // !defined(WIN32) && !defined(_WIN32)

Expand Down
1 change: 1 addition & 0 deletions Modules/Core/Common/include/itkMultiThreaderBase.h
Original file line number Diff line number Diff line change
Expand Up @@ -267,6 +267,7 @@ INTEL_PRAGMA_WARN_POP
STD_EXCEPTION,
UNKNOWN
} ThreadExitCode;

};
// clang-format off
ITK_GCC_PRAGMA_DIAG_POP()
Expand Down
1 change: 1 addition & 0 deletions Modules/Core/Common/include/itkNeighborhoodIterator.h
Original file line number Diff line number Diff line change
Expand Up @@ -332,6 +332,7 @@ class ITK_TEMPLATE_EXPORT NeighborhoodIterator : public ConstNeighborhoodIterato
{
this->SetPixel(this->GetCenterNeighborhoodIndex() - this->GetStride(axis), v);
}

};
} // namespace itk

Expand Down
1 change: 1 addition & 0 deletions Modules/Core/Common/include/itkOrientationAdapterBase.h
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ class ITK_TEMPLATE_EXPORT [[deprecated("Since ITK 5.3 use SpatialOrientationAdap
/** destructor, to silence "virtual class has non-virtual destructor()"
warnings */
virtual ~OrientationAdapterBase() = default;

};
} // namespace itk
#else // ITK_LEGACY_REMOVE
Expand Down
1 change: 1 addition & 0 deletions Modules/Core/Common/include/itkPeriodicBoundaryCondition.h
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ class ITK_TEMPLATE_EXPORT PeriodicBoundaryCondition : public ImageBoundaryCondit
*/
OutputPixelType
GetPixel(const IndexType & index, const TInputImage * image) const override;

};
} // end namespace itk

Expand Down
1 change: 1 addition & 0 deletions Modules/Core/Common/include/itkPoint.h
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,7 @@ class ITK_TEMPLATE_EXPORT Point : public FixedArray<TCoordRep, VPointDimension>
Point(const TPointValueType & v)
: BaseArray(v)
{}

Point(const ValueType & v)
: BaseArray(v)
{}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -294,6 +294,7 @@ class ITK_TEMPLATE_EXPORT ShapedFloodFilledFunctionConditionalConstIterator : pu
* 8 (26 in 3D).
*/
bool m_FullyConnected;

};
} // end namespace itk

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -802,6 +802,7 @@ class ShapedImageNeighborhoodRange final
m_RelativeLocation = location;
SubtractIndex(m_RelativeLocation, m_BufferedRegionData.m_Index);
}

};

} // namespace itk
Expand Down
1 change: 1 addition & 0 deletions Modules/Core/Common/include/itkSymmetricEigenAnalysis.h
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,7 @@ permuteColumnsWithSortIndices(QMatrix & eigenVectors, const std::vector<int> & i
// Apply it
eigenVectors = eigenVectors * perm;
}

} // end namespace detail

/** \class SymmetricEigenAnalysisEnums
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,7 @@ class ZeroFluxNeumannImageNeighborhoodPixelAccessPolicy final
{
m_NeighborhoodAccessor.Set(imageBufferPointer + m_PixelIndexValue, pixelValue);
}

};

} // namespace itk
Expand Down
1 change: 1 addition & 0 deletions Modules/Core/GPUCommon/include/itkGPUInPlaceImageFilter.h
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@ class ITK_TEMPLATE_EXPORT GPUInPlaceImageFilter
* \sa ProcessObject::ReleaseInputs() */
void
ReleaseInputs() override;

};

} // end namespace itk
Expand Down
1 change: 1 addition & 0 deletions Modules/Core/Mesh/include/itkMesh.h
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,7 @@ class ITK_TEMPLATE_EXPORT Mesh : public PointSet<TPixelType, VDimension, TMeshTr
{
return ((m_CellId == r.m_CellId) && (m_FeatureId == r.m_FeatureId));
}

}; // End Class: Mesh::BoundaryAssignmentIdentifier

/** Used for manipulating boundaries and boundary attributes. A
Expand Down
Loading

0 comments on commit 4293d83

Please sign in to comment.