From: Jim Procter <jprocter@issues.jalview.org>
Date: Tue, 31 May 2016 17:58:10 +0000 (+0100)
Subject: JAL-1551 JAL-2106 javadoc
X-Git-Tag: Release_2_10_0~194^2~3^2
X-Git-Url: http://source.jalview.org/gitweb/?a=commitdiff_plain;h=4b4c98b3be626bff6d72048447ebbac6070c2ee4;p=jalview.git

JAL-1551 JAL-2106 javadoc
---

diff --git a/src/jalview/api/DBRefEntryI.java b/src/jalview/api/DBRefEntryI.java
index 01b1d2c..2ce7e4a 100644
--- a/src/jalview/api/DBRefEntryI.java
+++ b/src/jalview/api/DBRefEntryI.java
@@ -73,6 +73,12 @@ public interface DBRefEntryI
    */
   public int getEndRes();
 
+  /**
+   * access a mapping, if present that can be used to map positions from the
+   * associated dataset sequence to the DBRef's sequence frame.
+   * 
+   * @return null or a valid mapping.
+   */
   public Mapping getMap();
 
   /**