JAL-98 javadoc added

[jalview.git] / src / jalview / analysis / Profile.java

diff --git a/src/jalview/analysis/Profile.java b/src/jalview/analysis/Profile.java
index b27da9f..d94d031 100644 (file)
--- a/src/jalview/analysis/Profile.java
+++ b/src/jalview/analysis/Profile.java
@@ -93,26 +93,53 @@ public class Profile
     return pid;
   }
 
+  /**
+   * Returns the full symbol counts for this profile
+   * 
+   * @return
+   */
   public ResidueCount getCounts()
   {
     return counts;
   }
 
+  /**
+   * Returns the number of sequences in the profile
+   * 
+   * @return
+   */
   public int getHeight()
   {
     return height;
   }
 
+  /**
+   * Returns the number of sequences in the profile which had a gap character
+   * (or were too short to be included in this column's profile)
+   * 
+   * @return
+   */
   public int getGapped()
   {
     return gapped;
   }
 
+  /**
+   * Returns the highest count for any symbol(s) in the profile
+   * 
+   * @return
+   */
   public int getMaxCount()
   {
     return maxCount;
   }
 
+  /**
+   * Returns the symbol (or concatenated symbols) which have the highest count
+   * in the profile, or an empty string if there were no symbols counted
+   * 
+   * @return
+   */
   public String getModalResidue()
   {
     return modalResidue;