Formatting changes
[jalview.git] / src / jalview / datamodel / Annotation.java
index 7858e3f..2316d13 100755 (executable)
@@ -21,24 +21,59 @@ package jalview.datamodel;
 import java.awt.*;\r
 \r
 \r
-public class Annotation {\r
+/**\r
+ * DOCUMENT ME!\r
+ *\r
+ * @author $author$\r
+ * @version $Revision$\r
+ */\r
+public class Annotation\r
+{\r
+    /** DOCUMENT ME!! */\r
     public String displayCharacter = "";\r
+\r
+    /** DOCUMENT ME!! */\r
     public String description = ""; // currently used as mouse over\r
+\r
+    /** DOCUMENT ME!! */\r
     public char secondaryStructure = ' '; // recognises H and E\r
+\r
+    /** DOCUMENT ME!! */\r
     public float value;\r
 \r
     // add visual cues here\r
+\r
+    /** DOCUMENT ME!! */\r
     public Color colour = Color.black;\r
 \r
-    public Annotation(String displayChar, String desc, char ss, float val) {\r
+    /**\r
+     * Creates a new Annotation object.\r
+     *\r
+     * @param displayChar DOCUMENT ME!\r
+     * @param desc DOCUMENT ME!\r
+     * @param ss DOCUMENT ME!\r
+     * @param val DOCUMENT ME!\r
+     */\r
+    public Annotation(String displayChar, String desc, char ss, float val)\r
+    {\r
         displayCharacter = displayChar;\r
         description = desc;\r
         secondaryStructure = ss;\r
         value = val;\r
     }\r
 \r
+    /**\r
+     * Creates a new Annotation object.\r
+     *\r
+     * @param displayChar DOCUMENT ME!\r
+     * @param desc DOCUMENT ME!\r
+     * @param ss DOCUMENT ME!\r
+     * @param val DOCUMENT ME!\r
+     * @param colour DOCUMENT ME!\r
+     */\r
     public Annotation(String displayChar, String desc, char ss, float val,\r
-        Color colour) {\r
+        Color colour)\r
+    {\r
         this(displayChar, desc, ss, val);\r
         this.colour = colour;\r
     }\r