JAL-2759 corrected old getVisibleBlocksIterator calls for new call
[jalview.git] / src / jalview / datamodel / HiddenColumns.java
index 5ac0abb..7862975 100644 (file)
@@ -31,17 +31,16 @@ import java.util.concurrent.locks.ReentrantReadWriteLock;
  * alignment. To iterate over the collection, or over visible columns/regions,
  * use an iterator obtained from one of:
  * 
- * - getBoundedIterator: iterate over the hidden regions, within some bounds
+ * - getBoundedIterator: iterates over the hidden regions, within some bounds,
+ * returning absolute positions
  * 
- * - getBoundedStartIterator: iterate over the start positions of hidden
- * regions, within some bounds
+ * - getBoundedStartIterator: iterates over the start positions of hidden
+ * regions, within some bounds, returning visible positions
  * 
- * - getVisContigsIterator: iterate over visible regions in a range, returning
+ * - getVisContigsIterator: iterates over visible regions in a range, returning
  * absolute positions
  * 
- * - getVisibleBlocksIterator
- * 
- * - getVisibleColsIterator: iterate over the visible *columns*
+ * - getVisibleColsIterator: iterates over the visible *columns*
  * 
  * For performance reasons, provide bounds where possible.
  * 
@@ -82,7 +81,8 @@ public class HiddenColumns
    * Methods which change the hiddenColumns collection. These methods should 
    * use a writeLock to prevent other threads accessing the hiddenColumns
    * collection while changes are being made. They should also reset the hidden
-   * columns cursor, and either update the hidden columns count, or set it to 0.
+   * columns cursor, and either update the hidden columns count, or set it to 0 
+   * (so that it will later be updated when needed).
    */
 
   /**