JAL-2759 cursor option for BoundedStartRegionIterator

[jalview.git] / src / jalview / datamodel / VisibleContigsIterator.java

diff --git a/src/jalview/datamodel/VisibleContigsIterator.java b/src/jalview/datamodel/VisibleContigsIterator.java
index ff060ac..d98121a 100644 (file)
--- a/src/jalview/datamodel/VisibleContigsIterator.java
+++ b/src/jalview/datamodel/VisibleContigsIterator.java
@@ -5,7 +5,9 @@ import java.util.Iterator;
 import java.util.List;
 
 /**
- * An iterator which iterates over visible regions in a range.
+ * An iterator which iterates over visible regions in a range. Provides a
+ * special "endsAtHidden" indicator to allow callers to determine if the final
+ * visible column is adjacent to a hidden region.
  */
 public class VisibleContigsIterator implements Iterator<int[]>
 {