Formatting changes
[jalview.git] / src / jalview / datamodel / SequenceFeature.java
index 702af73..5bf4e88 100755 (executable)
@@ -1,35 +1,56 @@
 /*\r
-* Jalview - A Sequence Alignment Editor and Viewer\r
-* Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
-*\r
-* This program is free software; you can redistribute it and/or\r
-* modify it under the terms of the GNU General Public License\r
-* as published by the Free Software Foundation; either version 2\r
-* of the License, or (at your option) any later version.\r
-*\r
-* This program is distributed in the hope that it will be useful,\r
-* but WITHOUT ANY WARRANTY; without even the implied warranty of\r
-* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
-* GNU General Public License for more details.\r
-*\r
-* You should have received a copy of the GNU General Public License\r
-* along with this program; if not, write to the Free Software\r
-* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
-*/\r
+ * Jalview - A Sequence Alignment Editor and Viewer\r
+ * Copyright (C) 2005 AM Waterhouse, J Procter, G Barton, M Clamp, S Searle\r
+ *\r
+ * This program is free software; you can redistribute it and/or\r
+ * modify it under the terms of the GNU General Public License\r
+ * as published by the Free Software Foundation; either version 2\r
+ * of the License, or (at your option) any later version.\r
+ *\r
+ * This program is distributed in the hope that it will be useful,\r
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
+ * GNU General Public License for more details.\r
+ *\r
+ * You should have received a copy of the GNU General Public License\r
+ * along with this program; if not, write to the Free Software\r
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA\r
+ */\r
 package jalview.datamodel;\r
 \r
-public class SequenceFeature {\r
+/**\r
+ * DOCUMENT ME!\r
+ *\r
+ * @author $author$\r
+ * @version $Revision$\r
+ */\r
+public class SequenceFeature\r
+{\r
     int begin;\r
     int end;\r
     String type;\r
     String description;\r
     String status;\r
 \r
-    public SequenceFeature() {\r
+    /**\r
+     * Creates a new SequenceFeature object.\r
+     */\r
+    public SequenceFeature()\r
+    {\r
     }\r
 \r
+    /**\r
+     * Creates a new SequenceFeature object.\r
+     *\r
+     * @param type DOCUMENT ME!\r
+     * @param start DOCUMENT ME!\r
+     * @param end DOCUMENT ME!\r
+     * @param description DOCUMENT ME!\r
+     * @param status DOCUMENT ME!\r
+     */\r
     public SequenceFeature(String type, int start, int end, String description,\r
-        String status) {\r
+        String status)\r
+    {\r
         this.type = type;\r
         this.begin = start;\r
         this.end = end;\r
@@ -37,62 +58,92 @@ public class SequenceFeature {
         this.status = status;\r
     }\r
 \r
-    public int getStart() {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public int getStart()\r
+    {\r
         return begin;\r
     }\r
 \r
-    public int getEnd() {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public int getEnd()\r
+    {\r
         return end;\r
     }\r
 \r
-    public String getType() {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public String getType()\r
+    {\r
         return type;\r
     }\r
 \r
-    public String getDescription() {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public String getDescription()\r
+    {\r
         return description;\r
     }\r
 \r
-    public String getStatus() {\r
+    /**\r
+     * DOCUMENT ME!\r
+     *\r
+     * @return DOCUMENT ME!\r
+     */\r
+    public String getStatus()\r
+    {\r
         return status;\r
     }\r
 \r
     /*\r
           <xs:enumeration value="active site" />\r
-    <xs:enumeration value="binding site" />\r
-    <xs:enumeration value="calcium-binding region" />\r
-    <xs:enumeration value="chain" />\r
-    <xs:enumeration value="cross-link" />\r
-    <xs:enumeration value="disulfide bond" />\r
-    <xs:enumeration value="DNA-binding region" />\r
-    <xs:enumeration value="domain" />\r
-    <xs:enumeration value="glycosylation site" />\r
-    <xs:enumeration value="helix" />\r
-    <xs:enumeration value="initiator methionine" />\r
-    <xs:enumeration value="lipid moiety-binding region" />\r
-    <xs:enumeration value="metal ion-binding site" />\r
-    <xs:enumeration value="modified residue" />\r
-    <xs:enumeration value="mutagenesis site" />\r
-    <xs:enumeration value="non-consecutive residues" />\r
-    <xs:enumeration value="non-terminal residue" />\r
-    <xs:enumeration value="nucleotide phosphate-binding region" />\r
-    <xs:enumeration value="peptide" />\r
-    <xs:enumeration value="propeptide" />\r
-    <xs:enumeration value="repeat" />\r
-    <xs:enumeration value="selenocysteine" />\r
-    <xs:enumeration value="sequence conflict" />\r
-    <xs:enumeration value="sequence variant" />\r
-    <xs:enumeration value="signal peptide" />\r
-    <xs:enumeration value="similar" />\r
-    <xs:enumeration value="site" />\r
-    <xs:enumeration value="splice variant" />\r
-    <xs:enumeration value="strand" />\r
-    <xs:enumeration value="thioether bond" />\r
-    <xs:enumeration value="thiolester bond" />\r
-    <xs:enumeration value="transit peptide" />\r
-    <xs:enumeration value="transmembrane region" />\r
-    <xs:enumeration value="turn" />\r
-    <xs:enumeration value="unsure residue" />\r
-    <xs:enumeration value="zinc finger region" />\r
-    */\r
+         <xs:enumeration value="binding site" />\r
+         <xs:enumeration value="calcium-binding region" />\r
+         <xs:enumeration value="chain" />\r
+         <xs:enumeration value="cross-link" />\r
+         <xs:enumeration value="disulfide bond" />\r
+         <xs:enumeration value="DNA-binding region" />\r
+         <xs:enumeration value="domain" />\r
+         <xs:enumeration value="glycosylation site" />\r
+         <xs:enumeration value="helix" />\r
+         <xs:enumeration value="initiator methionine" />\r
+         <xs:enumeration value="lipid moiety-binding region" />\r
+         <xs:enumeration value="metal ion-binding site" />\r
+         <xs:enumeration value="modified residue" />\r
+         <xs:enumeration value="mutagenesis site" />\r
+         <xs:enumeration value="non-consecutive residues" />\r
+         <xs:enumeration value="non-terminal residue" />\r
+         <xs:enumeration value="nucleotide phosphate-binding region" />\r
+         <xs:enumeration value="peptide" />\r
+         <xs:enumeration value="propeptide" />\r
+         <xs:enumeration value="repeat" />\r
+         <xs:enumeration value="selenocysteine" />\r
+         <xs:enumeration value="sequence conflict" />\r
+         <xs:enumeration value="sequence variant" />\r
+         <xs:enumeration value="signal peptide" />\r
+         <xs:enumeration value="similar" />\r
+         <xs:enumeration value="site" />\r
+         <xs:enumeration value="splice variant" />\r
+         <xs:enumeration value="strand" />\r
+         <xs:enumeration value="thioether bond" />\r
+         <xs:enumeration value="thiolester bond" />\r
+         <xs:enumeration value="transit peptide" />\r
+         <xs:enumeration value="transmembrane region" />\r
+         <xs:enumeration value="turn" />\r
+         <xs:enumeration value="unsure residue" />\r
+         <xs:enumeration value="zinc finger region" />\r
+     */\r
 }\r