JAL-674 javadoc
authorJim Procter <jprocter@dundee.ac.uk>
Wed, 12 Nov 2014 12:36:36 +0000 (12:36 +0000)
committerJim Procter <jprocter@dundee.ac.uk>
Wed, 12 Nov 2014 12:36:36 +0000 (12:36 +0000)
src/jalview/structure/StructureMapping.java

index e4749c9..cbc2c00 100644 (file)
@@ -64,6 +64,11 @@ public class StructureMapping
     return pdbid;
   }
 
+  /**
+   * 
+   * @param seqpos
+   * @return 0 or corresponding atom number for the sequence position
+   */
   public int getAtomNum(int seqpos)
   {
     if (mapping.length > seqpos)
@@ -76,6 +81,11 @@ public class StructureMapping
     }
   }
 
+  /**
+   * 
+   * @param seqpos
+   * @return 0 or the corresponding residue number for the sequence position
+   */
   public int getPDBResNum(int seqpos)
   {
     if (mapping.length > seqpos)
@@ -88,6 +98,11 @@ public class StructureMapping
     }
   }
 
+  /**
+   * 
+   * @param pdbResNum
+   * @return -1 or the corresponding sequence position for a pdb residue number
+   */
   public int getSeqPos(int pdbResNum)
   {
     for (int i = 0; i < mapping.length; i++)