JAL-2774 Added javadoc for new event parameters imp/JAL-2774
authorkiramt <k.mourao@dundee.ac.uk>
Tue, 7 Nov 2017 17:13:20 +0000 (17:13 +0000)
committerkiramt <k.mourao@dundee.ac.uk>
Tue, 7 Nov 2017 17:13:20 +0000 (17:13 +0000)
src/jalview/viewmodel/ViewportRanges.java

index 6331ffb..4bdaa81 100644 (file)
@@ -292,7 +292,9 @@ public class ViewportRanges extends ViewportProperties
   }
 
   /**
-   * Set start residue and start sequence together (fires single event)
+   * Set start residue and start sequence together (fires single event). The
+   * event supplies a pair of old values and a pair of new values: [old start
+   * residue, old start sequence] and [new start residue, new start sequence]
    * 
    * @param res
    *          the start residue