From: kiramt <k.mourao@dundee.ac.uk>
Date: Tue, 7 Nov 2017 17:13:20 +0000 (+0000)
Subject: JAL-2774 Added javadoc for new event parameters
X-Git-Tag: Release_2_10_3b1~28^2~11^2
X-Git-Url: http://source.jalview.org/gitweb/?a=commitdiff_plain;h=f3d0dc3395aff566e8005e6a6a9a13bf795c14a4;hp=e510f5ac2ae4530767c92cbe99e871c7f21eb36a;p=jalview.git

JAL-2774 Added javadoc for new event parameters
---

diff --git a/src/jalview/viewmodel/ViewportRanges.java b/src/jalview/viewmodel/ViewportRanges.java
index 6331ffb..4bdaa81 100644
--- a/src/jalview/viewmodel/ViewportRanges.java
+++ b/src/jalview/viewmodel/ViewportRanges.java
@@ -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