JAL-2438 Javadoc updates
authorgmungoc <g.m.carstairs@dundee.ac.uk>
Tue, 14 Mar 2017 12:25:09 +0000 (12:25 +0000)
committergmungoc <g.m.carstairs@dundee.ac.uk>
Tue, 14 Mar 2017 12:25:09 +0000 (12:25 +0000)
src/jalview/renderer/seqfeatures/FeatureColourFinder.java
src/jalview/viewmodel/seqfeatures/FeatureRendererModel.java

index 6f4d4de..761f418 100644 (file)
@@ -41,14 +41,16 @@ public class FeatureColourFinder
   /**
    * Answers the feature colour to show for the given sequence and column
    * position. This delegates to the FeatureRenderer to find the colour, which
-   * will depend on feature location, visibility, ordering, and whether or not
-   * transparency is applied. For feature rendering with transparency, this
-   * class provides a dummy 'offscreen' graphics context where multiple feature
-   * colours can be overlaid and the combined colour read back.
+   * will depend on feature location, visibility, ordering, colour scheme, and
+   * whether or not transparency is applied. For feature rendering with
+   * transparency, this class provides a dummy 'offscreen' graphics context
+   * where multiple feature colours can be overlaid and the combined colour read
+   * back.
    * 
    * @param defaultColour
    * @param seq
    * @param column
+   *          alignment column position (base zero)
    * @return
    */
   public Color findFeatureColour(Color defaultColour, SequenceI seq,
index 100b58f..84c9477 100644 (file)
@@ -550,9 +550,10 @@ public abstract class FeatureRendererModel implements
   }
 
   /**
-   * Returns the configured colour for a specific feature using current feature
-   * settings. This does not include any consideration of feature visibility,
-   * colour transparency, graduated colour shading etc.
+   * Returns the configured colour for a particular feature instance. This
+   * includes calculation of 'colour by label', or of a graduated score colour,
+   * if applicable. It does not take into account feature visibility or colour
+   * transparency.
    * 
    * @param feature
    * @return