JAL-1517 source formatting
[jalview.git] / src / jalview / schemes / ColourSchemeI.java
index c1550cc..67d23ea 100755 (executable)
@@ -40,10 +40,14 @@ public interface ColourSchemeI
 
   /**
    * 
-   * @param c - sequence symbol or gap
-   * @param j - position in seq
-   * @param seq - sequence being coloured
-   * @return context dependent colour for the given symbol at the position in the given sequence
+   * @param c
+   *          - sequence symbol or gap
+   * @param j
+   *          - position in seq
+   * @param seq
+   *          - sequence being coloured
+   * @return context dependent colour for the given symbol at the position in
+   *         the given sequence
    */
   public Color findColour(char c, int j, SequenceI seq);
 
@@ -54,15 +58,18 @@ public interface ColourSchemeI
 
   /**
    * assign the given conservation to the colourscheme
+   * 
    * @param c
    */
   public void setConservation(jalview.analysis.Conservation c);
 
   /**
    * enable or disable conservation shading for this colourscheme
-   * @param conservationApplied 
+   * 
+   * @param conservationApplied
    */
   public void setConservationApplied(boolean conservationApplied);
+
   /**
    * 
    * @return true if conservation shading is enabled for this colourscheme
@@ -71,13 +78,14 @@ public interface ColourSchemeI
 
   /**
    * set scale factor for bleaching of colour in unconserved regions
+   * 
    * @param i
    */
   public void setConservationInc(int i);
 
   /**
    * 
-   * @return scale factor for bleaching colour in unconserved regions 
+   * @return scale factor for bleaching colour in unconserved regions
    */
   public int getConservationInc();
 
@@ -88,14 +96,20 @@ public interface ColourSchemeI
   public int getThreshold();
 
   /**
-   * set percentage identity threshold and type of %age identity calculation for shading
-   * @param ct 0..100 percentage identity for applying this colourscheme
-   * @param ignoreGaps when true, calculate PID without including gapped positions
+   * set percentage identity threshold and type of %age identity calculation for
+   * shading
+   * 
+   * @param ct
+   *          0..100 percentage identity for applying this colourscheme
+   * @param ignoreGaps
+   *          when true, calculate PID without including gapped positions
    */
   public void setThreshold(int ct, boolean ignoreGaps);
 
   /**
-   * recalculate dependent data using the given sequence collection, taking account of hidden rows
+   * recalculate dependent data using the given sequence collection, taking
+   * account of hidden rows
+   * 
    * @param alignment
    * @param hiddenReps
    */
@@ -103,7 +117,9 @@ public interface ColourSchemeI
           Map<SequenceI, SequenceCollectionI> hiddenReps);
 
   /**
-   * create a new instance of the colourscheme configured to colour the given connection
+   * create a new instance of the colourscheme configured to colour the given
+   * connection
+   * 
    * @param sg
    * @param hiddenRepSequences
    * @return copy of current scheme with any inherited settings transfered