From: Jim Procter <jprocter@dundee.ac.uk>
Date: Wed, 12 Nov 2014 12:36:36 +0000 (+0000)
Subject: JAL-674 javadoc
X-Git-Tag: Release_2_8_2b1^2~36^2~5
X-Git-Url: http://source.jalview.org/gitweb/?a=commitdiff_plain;h=9a47b82e8b3b647773c1c0df94b6ce6b477587e4;p=jalview.git

JAL-674 javadoc
---

diff --git a/src/jalview/structure/StructureMapping.java b/src/jalview/structure/StructureMapping.java
index e4749c9..cbc2c00 100644
--- a/src/jalview/structure/StructureMapping.java
+++ b/src/jalview/structure/StructureMapping.java
@@ -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++)