[groovy] branch master updated: improve javadoc

[pa...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

paulk pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/groovy.git


The following commit(s) were added to refs/heads/master by this push:
     new ceff650447 improve javadoc
ceff650447 is described below

commit ceff650447ca6f11e4f447347593f7d25bfac506
Author: Paul King <pa...@asert.com.au>
AuthorDate: Thu Aug 3 15:24:19 2023 +1000

    improve javadoc
---
 src/main/java/org/codehaus/groovy/runtime/ArrayGroovyMethods.java | 5 +++--
 src/main/java/org/codehaus/groovy/util/ArrayIterator.java         | 1 +
 2 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/src/main/java/org/codehaus/groovy/runtime/ArrayGroovyMethods.java b/src/main/java/org/codehaus/groovy/runtime/ArrayGroovyMethods.java
index 7acf5f280e..1449fd7baa 100644
--- a/src/main/java/org/codehaus/groovy/runtime/ArrayGroovyMethods.java
+++ b/src/main/java/org/codehaus/groovy/runtime/ArrayGroovyMethods.java
@@ -4644,10 +4644,11 @@ public class ArrayGroovyMethods extends DefaultGroovyMethodsSupport {
     // iterator
 
     /**
-     * Returns an Iterator for the given array.
+     * Returns an Iterator which traverses the given array in index order.
      *
      * @param self an array
-     * @return an Iterator for the given Array.
+     * @return an Iterator backed by the given Array.
+     * @see ArrayIterator
      * @since 1.6.4
      */
     public static <T> Iterator<T> iterator(final T[] self) {
diff --git a/src/main/java/org/codehaus/groovy/util/ArrayIterator.java b/src/main/java/org/codehaus/groovy/util/ArrayIterator.java
index a667267f6e..4b8d75f2d9 100644
--- a/src/main/java/org/codehaus/groovy/util/ArrayIterator.java
+++ b/src/main/java/org/codehaus/groovy/util/ArrayIterator.java
@@ -23,6 +23,7 @@ import java.util.NoSuchElementException;
 
 /**
  * Allows an array to be used where an Iterator is expected.
+ * The iterator is backed by the original array and iterated in index order.
  */
 public class ArrayIterator<T> implements Iterator<T> {
     private final T[] array;