JAL-2292 added javadoc for compareChar(..) utility method

[jalview.git] / src / jalview / util / Comparison.java

diff --git a/src/jalview/util/Comparison.java b/src/jalview/util/Comparison.java
index a8ad086..5269d4f 100644 (file)
--- a/src/jalview/util/Comparison.java
+++ b/src/jalview/util/Comparison.java
@@ -416,6 +416,18 @@ public class Comparison
     return isNucleotide(oneDArray);
   }
 
+  /**
+   * Compares two chars either case sensitively or case insensitively depending
+   * on the caseSensitive flag
+   * 
+   * @param c1
+   *          first char
+   * @param c2
+   *          second char to compare with
+   * @param caseSensitive
+   *          if true comparison will be case sensitive otherwise its not
+   * @return
+   */
   public static boolean compareChars(char c1, char c2, boolean caseSensitive)
   {
     boolean sameCase = (Character.isUpperCase(c1) && Character