[jsemver] 54/95: Add missing Javadoc to the Stream's iterator class

[Alexandre Viau]

This is an automated email from the git hooks/post-receive script.

reazem-guest pushed a commit to branch master
in repository jsemver.

commit 6df67e8de26179685af1aad6c4cea31121fd1cce
Author: Zafar Khaja <zafarkhaja at gmail.com>
Date:   Wed Nov 20 20:19:07 2013 +0400

    Add missing Javadoc to the Stream's iterator class
---
 src/main/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<E> implements Iterable<E> {
     public Iterator<E> iterator() {
         return new Iterator<E>() {
 
+            /**
+             * 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;
 
             /**

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-java/jsemver.git