From 4a1935d99041e3ddb4767e61b2d7922965a3e6cc Mon Sep 17 00:00:00 2001
From: Adam He <adamhe@google.com>
Date: Mon, 13 Jul 2020 15:28:28 -0700
Subject: [PATCH] Updated docs for IInlineSuggestionsRequestCallback.aidl.

Fixes: 160729678
Test: atest android.autofillservice.cts.inline
Change-Id: Ie49267a594524651f0965296c164f7d1e0628cee
---
 .../IInlineSuggestionsRequestCallback.aidl    | 51 ++++++++++++-------
 1 file changed, 32 insertions(+), 19 deletions(-)

diff --git a/core/java/com/android/internal/view/IInlineSuggestionsRequestCallback.aidl b/core/java/com/android/internal/view/IInlineSuggestionsRequestCallback.aidl
index cf1220c08467c..5bbd741741625 100644
--- a/core/java/com/android/internal/view/IInlineSuggestionsRequestCallback.aidl
+++ b/core/java/com/android/internal/view/IInlineSuggestionsRequestCallback.aidl
@@ -22,40 +22,53 @@ import android.view.inputmethod.InlineSuggestionsRequest;
 import com.android.internal.view.IInlineSuggestionsResponseCallback;
 
 /**
- * Binder interface for the IME service to send an inline suggestion request to the system.
+ * Binder interface for the IME service to send {@link InlineSuggestionsRequest} or notify other IME
+ * service events to the system.
  * {@hide}
  */
 oneway interface IInlineSuggestionsRequestCallback {
-    // Indicates that the current IME does not support inline suggestion.
+    /** Indicates that the current IME does not support inline suggestion. */
     void onInlineSuggestionsUnsupported();
 
-    // Sends the inline suggestions request from IME to Autofill. Calling this method indicates
-    // that the IME input is started on the view corresponding to the request.
+    /**
+     * Sends the inline suggestions request from IME to Autofill. Calling this method indicates
+     * that the IME input is started on the view corresponding to the request.
+     */
     void onInlineSuggestionsRequest(in InlineSuggestionsRequest request,
             in IInlineSuggestionsResponseCallback callback);
 
-    // Signals that {@link android.inputmethodservice.InputMethodService
-    //  #onStartInput(EditorInfo, boolean)} is called on the given focused field.
+    /**
+     * Signals that {@link android.inputmethodservice.InputMethodService
+     * #onStartInput(EditorInfo, boolean)} is called on the given focused field.
+     */
     void onInputMethodStartInput(in AutofillId imeFieldId);
 
-    // Signals that {@link android.inputmethodservice.InputMethodService
-    //  #dispatchOnShowInputRequested(int, boolean)} is called and shares the call result.
-    //  The true value of {@code requestResult} means the IME is about to be shown, while
-    //  false value means the IME will not be shown.
+    /**
+     * Signals that {@link android.inputmethodservice.InputMethodService
+     * #dispatchOnShowInputRequested(int, boolean)} is called and shares the call result.
+     * The true value of {@code requestResult} means the IME is about to be shown, while
+     * false value means the IME will not be shown.
+     */
     void onInputMethodShowInputRequested(boolean requestResult);
 
-    // Signals that {@link android.inputmethodservice.InputMethodService
-    //  #onStartInputView(EditorInfo, boolean)} is called on the field specified by the earlier
-    //  {@link #onInputMethodStartInput(AutofillId)}.
+    /**
+     * Signals that {@link android.inputmethodservice.InputMethodService
+     * #onStartInputView(EditorInfo, boolean)} is called on the field specified by the earlier
+     * {@link #onInputMethodStartInput(AutofillId)}.
+     */
     void onInputMethodStartInputView();
 
-    // Signals that {@link android.inputmethodservice.InputMethodService
-    //  #onFinishInputView(boolean)} is called on the field specified by the earlier
-    //  {@link #onInputMethodStartInput(AutofillId)}.
+    /**
+     * Signals that {@link android.inputmethodservice.InputMethodService
+     * #onFinishInputView(boolean)} is called on the field specified by the earlier
+     * {@link #onInputMethodStartInput(AutofillId)}.
+     */
     void onInputMethodFinishInputView();
 
-    // Signals that {@link android.inputmethodservice.InputMethodService
-    //  #onFinishInput()} is called on the field specified by the earlier
-    //  {@link #onInputMethodStartInput(AutofillId)}.
+    /**
+     * Signals that {@link android.inputmethodservice.InputMethodService
+     * #onFinishInput()} is called on the field specified by the earlier
+     * {@link #onInputMethodStartInput(AutofillId)}.
+     */
     void onInputMethodFinishInput();
 }