JAL-2438 unit test, fixes, Javadoc updates

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

diff --git a/src/jalview/api/FeatureRenderer.java b/src/jalview/api/FeatureRenderer.java
index 3565488..839119d 100644 (file)
--- a/src/jalview/api/FeatureRenderer.java
+++ b/src/jalview/api/FeatureRenderer.java
@@ -38,17 +38,24 @@ public interface FeatureRenderer
 {
 
   /**
-   * compute the perceived colour for a given column position in sequenceI,
-   * taking transparency and feature visibility into account.
+   * Returns the combined feature colour for a given sequence and column
+   * position, taking into account feature colour schemes, ordering, feature and
+   * feature group visibility, and transparency. Returns null if there is no
+   * visible feature at the position.
+   * <p>
+   * The Graphics argument is optional and may be null if no transparency is
+   * applied. With feature transparency, visible features are written to the
+   * graphics context and the composite colour can be read off.
+   * <p>
+   * This is provided for use by Structure Viewers and the Overview Window to
+   * get the feature colour of the rendered sequence.
    * 
-   * @param sequenceI
-   *          - sequence providing features
-   * @param r
-   *          - column position
+   * @param sequence
+   * @param column
    * @param g
    * @return
    */
-  Color findFeatureColour(SequenceI sequenceI, int r, Graphics g);
+  Color findFeatureColour(SequenceI sequence, int column, Graphics g);
 
   /**
    * trigger the feature discovery process for a newly created feature renderer.