From 6df67e8de26179685af1aad6c4cea31121fd1cce Mon Sep 17 00:00:00 2001 From: Zafar Khaja Date: Wed, 20 Nov 2013 20:19:07 +0400 Subject: [PATCH] Add missing Javadoc to the Stream's iterator class --- .../java/com/github/zafarkhaja/semver/util/Stream.java | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/main/java/com/github/zafarkhaja/semver/util/Stream.java b/src/main/java/com/github/zafarkhaja/semver/util/Stream.java index 9d5d041..62c509f 100644 --- a/src/main/java/com/github/zafarkhaja/semver/util/Stream.java +++ b/src/main/java/com/github/zafarkhaja/semver/util/Stream.java @@ -213,6 +213,14 @@ public class Stream implements Iterable { public Iterator iterator() { return new Iterator() { + /** + * The index to indicate the current position + * of this iterator. + * + * The starting point is set to the current + * value of this stream's offset, so that it + * doesn't iterate over consumed elements. + */ private int index = offset; /**