Update function names, Javadoc, comments in ImeUtils

content/public/android/java/src/org/chromium/content/browser/input/ImeUtils.java

 // Copyright 2016 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 package org.chromium.content.browser.input;
 
 import android.text.Editable;
 import android.text.InputType;
 import android.text.Selection;
 import android.util.StringBuilderPrinter;
@@ skipping 39 matching lines @@
                 outAttrs.inputType |= EditorInfo.TYPE_TEXT_FLAG_AUTO_CORRECT;
             }
         } else if (inputType == TextInputType.TEXT_AREA
                 || inputType == TextInputType.CONTENT_EDITABLE) {
             outAttrs.inputType |= EditorInfo.TYPE_TEXT_FLAG_MULTI_LINE;
             if ((inputFlags & WebTextInputFlags.AutocorrectOff) == 0) {
                 outAttrs.inputType |= EditorInfo.TYPE_TEXT_FLAG_AUTO_CORRECT;
             }
             outAttrs.imeOptions |= EditorInfo.IME_ACTION_NONE;
         } else if (inputType == TextInputType.PASSWORD) {
-            // Password
             outAttrs.inputType =
                     InputType.TYPE_CLASS_TEXT | InputType.TYPE_TEXT_VARIATION_WEB_PASSWORD;
             outAttrs.imeOptions |= EditorInfo.IME_ACTION_GO;
         } else if (inputType == TextInputType.SEARCH) {
-            // Search
             outAttrs.imeOptions |= EditorInfo.IME_ACTION_SEARCH;
         } else if (inputType == TextInputType.URL) {
-            // Url
             outAttrs.inputType = InputType.TYPE_CLASS_TEXT | InputType.TYPE_TEXT_VARIATION_URI;
             outAttrs.imeOptions |= EditorInfo.IME_ACTION_GO;
         } else if (inputType == TextInputType.EMAIL) {
             // Email
             outAttrs.inputType =
                     InputType.TYPE_CLASS_TEXT | InputType.TYPE_TEXT_VARIATION_WEB_EMAIL_ADDRESS;
             outAttrs.imeOptions |= EditorInfo.IME_ACTION_GO;
         } else if (inputType == TextInputType.TELEPHONE) {
             // Telephone
             // Number and telephone do not have both a Tab key and an
@@ skipping 20 matching lines @@
         }
         // Content editable doesn't use autocapitalize so we need to set it manually.
         if (inputType == TextInputType.CONTENT_EDITABLE) {
             outAttrs.inputType |= InputType.TYPE_TEXT_FLAG_CAP_SENTENCES;
         }
 
         outAttrs.initialSelStart = initialSelStart;
         outAttrs.initialSelEnd = initialSelEnd;
     }
 
-    public static String getEditorInfoDebugString(EditorInfo editorInfo) {
+    /**
+     * @param editorInfo The EditorInfo
+     * @return Debug string for the given {@EditorInfo}.
+     */
+    static String getEditorInfoDebugString(EditorInfo editorInfo) {
         StringBuilder builder = new StringBuilder();
         StringBuilderPrinter printer = new StringBuilderPrinter(builder);
         editorInfo.dump(printer, "");
         return builder.toString();
     }
 
-    public static String getEditableDebugString(Editable editable) {
+    /**
+     * @param editable The editable.
+     * @return Debug string for the given {@Editable}.
+     */
+    static String getEditableDebugString(Editable editable) {
         return String.format(Locale.US, "Editable {[%s] SEL[%d %d] COM[%d %d]}",
                 editable.toString(), Selection.getSelectionStart(editable),
                 Selection.getSelectionEnd(editable),
                 BaseInputConnection.getComposingSpanStart(editable),
                 BaseInputConnection.getComposingSpanEnd(editable));
     }
 
     /**
-     * Dump the given {@CorrectionInfo} into class.
-     * @param correctionInfo
-     * @return User-readable {@CorrectionInfo}.
+     * @param correctionInfo The correction info.
+     * @return Debug string for the given {@CorrectionInfo}.
      */
-    static String getCorrectInfoDebugString(CorrectionInfo correctionInfo) {
+    static String getCorrectionInfoDebugString(CorrectionInfo correctionInfo) {
         // TODO(changwan): implement it properly if needed.
         return correctionInfo.toString();
     }
 
-    // TODO(changwan): remove these once implementation becomes stable.
-    static void checkCondition(boolean value) {
-        if (!value) {
-            throw new AssertionError();
-        }
+    /**
+     * Check the given condition and raise an error if it is false.
+     * @param condition The condition to check.
+     */
+    static void checkCondition(boolean condition) {
+        if (!condition) throw new AssertionError();
     }
 
-    static void checkCondition(String msg, boolean value) {
-        if (!value) {
-            throw new AssertionError(msg);
-        }
+    /**
+     * Check the given condition and raise an error if it is false.
+     * @param msg A message to show when raising an error.
+     * @param condition The condition to check.
+     */
+    static void checkCondition(String msg, boolean condition) {
+        if (!condition) throw new AssertionError(msg);
     }
 
+    /**
+     * Check that the current thread is UI thread, and raise an error if it is not.
+     */
     static void checkOnUiThread() {
         checkCondition("Should be on UI thread.", ThreadUtils.runningOnUiThread());
     }
 }