JAL-2016 corrected Javadoc, added test for anonymous instance

[jalview.git] / src / jalview / api / FeatureSettingsModelI.java

diff --git a/src/jalview/api/FeatureSettingsModelI.java b/src/jalview/api/FeatureSettingsModelI.java
index 28f5c77..c0fc523 100644 (file)
--- a/src/jalview/api/FeatureSettingsModelI.java
+++ b/src/jalview/api/FeatureSettingsModelI.java
@@ -68,8 +68,13 @@ public interface FeatureSettingsModelI extends Comparator<String>
   float getTransparency();
 
   /**
-   * Returns -1 if feature1 'precedes' (is displayed on top of) feature 2, +1 if
-   * feature2 is on top of feature1, or 0 if we don't care
+   * Returns -1 if feature1 is displayed before (below) feature 2, +1 if
+   * feature2 is displayed after (on top of) feature1, or 0 if we don't care.
+   * 
+   * <br>
+   * Note that this is the opposite ordering to how features are displayed in
+   * the feature settings dialogue. FeatureRendererModel.setFeaturePriority
+   * takes care of converting between the two.
    * 
    * @param feature1
    * @param feature2