From: jprocter <jprocter@compbio.dundee.ac.uk>
Date: Fri, 4 May 2012 15:48:05 +0000 (+0100)
Subject: javadoc
X-Git-Url: http://source.jalview.org/gitweb/?a=commitdiff_plain;ds=sidebyside;h=dbddb1d9b57c2bd3a70b5930fcb69eb6fce22878;p=jalview.git

javadoc
---

diff --git a/src/jalview/schemes/ColourSchemeProperty.java b/src/jalview/schemes/ColourSchemeProperty.java
index 3738f61..a7f2311 100755
--- a/src/jalview/schemes/ColourSchemeProperty.java
+++ b/src/jalview/schemes/ColourSchemeProperty.java
@@ -383,20 +383,21 @@ public class ColourSchemeProperty
   }
 
   /**
-   * DOCUMENT ME!
+   * Construct an instance of ColourSchemeI corresponding to the given colourscheme index
    * 
    * @param seqs
-   *          DOCUMENT ME!
+   *          sequences to be coloured by colourscheme
    * @param width
-   *          DOCUMENT ME!
+   *          geometry of alignment
    * @param index
-   *          DOCUMENT ME!
+   *          colourscheme number 
    * 
-   * @return DOCUMENT ME!
+   * @return null or an instance of the colourscheme configured to colour given sequence set
    */
   public static ColourSchemeI getColour(java.util.Vector seqs, int width,
           int index)
   {
+    // TODO 3.0 2.8 refactor signature to take an alignmentI like container so colourschemes based on annotation can be initialised
     ColourSchemeI cs = null;
 
     switch (index)