JAL-1739 Javadoc updated for Lambda expression parser functions

[jalview.git] / src / jalview / ext / ensembl / EnsemblLookup.java

diff --git a/src/jalview/ext/ensembl/EnsemblLookup.java b/src/jalview/ext/ensembl/EnsemblLookup.java
index f314b0a..5a616f0 100644 (file)
--- a/src/jalview/ext/ensembl/EnsemblLookup.java
+++ b/src/jalview/ext/ensembl/EnsemblLookup.java
@@ -124,8 +124,13 @@ public class EnsemblLookup extends EnsemblRestClient
   }
 
   /**
-   * Calls the Ensembl lookup REST endpoint and retrieves the 'Parent' for the
-   * given identifier, or null if not found
+   * Calls the Ensembl lookup REST endpoint and returns
+   * <ul>
+   * <li>the 'id' for the identifier if its type is "Gene"</li>
+   * <li>the 'Parent' if its type is 'Transcript'</li>
+   * <ul>
+   * If the type is 'Translation', does a recursive call to this method, passing
+   * in the 'Parent' (transcript id).
    * 
    * @param identifier
    * @return
@@ -148,8 +153,11 @@ public class EnsemblLookup extends EnsemblRestClient
   }
 
   /**
+   * Calls the /lookup/id rest service and delegates parsing of the JSON
+   * response to the supplied parser
+   * 
    * @param identifier
-   * @param attribute
+   * @param parser
    * @return
    */
   protected String getResult(String identifier,