Merge branch 'develop' into bug/JAL-2323disulfideOverview

[jalview.git] / src / jalview / ext / android / SparseShortArray.java

diff --git a/src/jalview/ext/android/SparseShortArray.java b/src/jalview/ext/android/SparseShortArray.java
index 375d745..f961f55 100644 (file)
--- a/src/jalview/ext/android/SparseShortArray.java
+++ b/src/jalview/ext/android/SparseShortArray.java
@@ -40,12 +40,15 @@ package jalview.ext.android;
  * order in the case of <code>valueAt(int)<code>.
  * </p>
  */
-/**
- * A copy of SparseShortArray designed to store short values (to minimise space
- * usage).
+
+/*
+ * Added to Jalview September 2016. A copy of SparseIntArray designed to store
+ * short values (to minimise space usage).
  * <p>
- * Note that operations append, put, add throw ArithmeticException if the
- * resulting value overflows the range of a short.
+ * Note that operations append, put, add throw ArithmeticException if either the
+ * key or the resulting value overflows the range of a short. Calling code
+ * should trap and handle this, for example by switching to using a
+ * SparseIntArray instead.
  */
 public class SparseShortArray implements Cloneable
 {