From 11a236a172ac7d64a6963d369515801ff29dc3ac Mon Sep 17 00:00:00 2001 From: agnostic-apollo Date: Tue, 16 Mar 2021 03:46:34 +0500 Subject: [PATCH] Update TerminalView and TerminalViewClient javadocs --- .../src/main/java/com/termux/view/TerminalView.java | 11 ++++------- .../main/java/com/termux/view/TerminalViewClient.java | 9 ++++++--- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/terminal-view/src/main/java/com/termux/view/TerminalView.java b/terminal-view/src/main/java/com/termux/view/TerminalView.java index 995f8b9a..0eea85d4 100644 --- a/terminal-view/src/main/java/com/termux/view/TerminalView.java +++ b/terminal-view/src/main/java/com/termux/view/TerminalView.java @@ -210,14 +210,11 @@ public final class TerminalView extends View { } /** - * @param terminalViewClient Interface for communicating with the terminal view client. It allows - * for getting various configuration options from the client and - * for sending back data to the client like logs, key events, both - * hardware and IME (which makes it different from that available with - * {@link View#setOnKeyListener(OnKeyListener)}, etc. + * @param client The {@link TerminalViewClient} interface implementation to allow + * for communication between {@link TerminalView} and its client. */ - public void setTerminalViewClient(TerminalViewClient terminalViewClient) { - this.mClient = terminalViewClient; + public void setTerminalViewClient(TerminalViewClient client) { + this.mClient = client; } /** diff --git a/terminal-view/src/main/java/com/termux/view/TerminalViewClient.java b/terminal-view/src/main/java/com/termux/view/TerminalViewClient.java index 25be7d9d..a1ed550b 100644 --- a/terminal-view/src/main/java/com/termux/view/TerminalViewClient.java +++ b/terminal-view/src/main/java/com/termux/view/TerminalViewClient.java @@ -3,13 +3,16 @@ package com.termux.view; import android.view.KeyEvent; import android.view.MotionEvent; import android.view.ScaleGestureDetector; +import android.view.View; import com.termux.terminal.TerminalSession; /** - * Input and scale listener which may be set on a {@link TerminalView} through - * {@link TerminalView#setTerminalViewClient(TerminalViewClient)}. - *

+ * The interface for communication between {@link TerminalView} and its client. It allows for getting + * various configuration options from the client and for sending back data to the client like logs, + * key events, both hardware and IME (which makes it different from that available with + * {@link View#setOnKeyListener(View.OnKeyListener)}, etc. It must be set for the + * {@link TerminalView} through {@link TerminalView#setTerminalViewClient(TerminalViewClient)}. */ public interface TerminalViewClient {