Skip to content

Commit c02faaa

Browse files
committed
DOC: Document that ImageRegionIterator constructors initialize at begin
Explicitly specify that those constructors initialize the iterator at the begin of the region.
1 parent e0b7413 commit c02faaa

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

Modules/Core/Common/include/itkImageRegionConstIterator.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,8 +146,8 @@ class ITK_TEMPLATE_EXPORT ImageRegionConstIterator : public ImageConstIterator<T
146146
m_SpanEndOffset = 0;
147147
}
148148

149-
/** Constructor establishes an iterator to walk a particular image and a
150-
* particular region of that image. */
149+
/** Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes
150+
* the iterator at the begin of the region. */
151151
ImageRegionConstIterator(const ImageType * ptr, const RegionType & region)
152152
: ImageConstIterator<TImage>(ptr, region)
153153
{

Modules/Core/Common/include/itkImageRegionIterator.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,8 @@ class ITK_TEMPLATE_EXPORT ImageRegionIterator : public ImageRegionConstIterator<
9999
/** Default constructor. Needed since we provide a cast constructor. */
100100
ImageRegionIterator() = default;
101101

102-
/** Constructor establishes an iterator to walk a particular image and a
103-
* particular region of that image. */
102+
/** Constructor establishes an iterator to walk a particular image and a particular region of that image. Initializes
103+
* the iterator at the begin of the region. */
104104
ImageRegionIterator(ImageType * ptr, const RegionType & region);
105105

106106
/** Constructor that can be used to cast from an ImageIterator to an

0 commit comments

Comments
 (0)