JAL-2106 JAL-1926 updated source doc for set/getSourceDBRef
authortcofoegbu <tcnofoegbu@dundee.ac.uk>
Tue, 17 May 2016 11:31:25 +0000 (12:31 +0100)
committertcofoegbu <tcnofoegbu@dundee.ac.uk>
Tue, 17 May 2016 11:31:25 +0000 (12:31 +0100)
src/jalview/datamodel/SequenceI.java

index 60040d8..69eb1d4 100755 (executable)
@@ -435,7 +435,21 @@ public interface SequenceI extends ASequenceI
    */
   public PDBEntry getPDBEntry(String pdbId);
 
+  /**
+   * Set the distinct source database, and accession number from which a
+   * sequence and its start-end data were derived from. This is very important
+   * for SIFTS mappings and must be set prior to performing SIFTS mapping.
+   * 
+   * @param dbRef
+   *          the source dbRef for the sequence
+   */
   public void setSourceDBRef(DBRefEntryI dbRef);
 
+  /**
+   * Get the distinct source database, and accession number from which a
+   * sequence and its start-end data were derived from.
+   * 
+   * @return
+   */
   public DBRefEntryI getSourceDBRef();
 }