From 0eddc136e955aa8284efe20b7ef7bc2ecaf71041 Mon Sep 17 00:00:00 2001 From: Guillaume Nodet Date: Wed, 8 Mar 2023 20:20:01 +0100 Subject: [PATCH] Fix javadoc --- .../main/java/org/jline/reader/LineReader.java | 4 ++-- .../jline/builtins/telnet/ConnectionData.java | 2 +- .../jline/builtins/telnet/ConnectionManager.java | 10 +++++----- .../org/jline/builtins/telnet/PortListener.java | 16 ++++++++-------- 4 files changed, 16 insertions(+), 16 deletions(-) diff --git a/reader/src/main/java/org/jline/reader/LineReader.java b/reader/src/main/java/org/jline/reader/LineReader.java index f09f20871..c22e7df1e 100644 --- a/reader/src/main/java/org/jline/reader/LineReader.java +++ b/reader/src/main/java/org/jline/reader/LineReader.java @@ -21,7 +21,7 @@ /** Read lines from the console, with input editing. * - *

Thread safety

+ *

Thread safety

* The LineReader implementations are not thread safe, * thus you should not attempt to use a single reader in several threads. * Any attempt to call one of the readLine call while one is @@ -31,7 +31,7 @@ * {@link #printAbove(String)} or {@link #printAbove(AttributedString)} at * any time to allow text to be printed above the current prompt. * - *

Prompt strings

+ *

Prompt strings

* It is traditional for an interactive console-based program * to print a short prompt string to signal that the user is expected * to type a command. JLine supports 3 kinds of prompt string: diff --git a/remote-telnet/src/main/java/org/jline/builtins/telnet/ConnectionData.java b/remote-telnet/src/main/java/org/jline/builtins/telnet/ConnectionData.java index d5c829ae7..260d15c25 100644 --- a/remote-telnet/src/main/java/org/jline/builtins/telnet/ConnectionData.java +++ b/remote-telnet/src/main/java/org/jline/builtins/telnet/ConnectionData.java @@ -331,7 +331,7 @@ public void setNegotiatedTerminalType(String termtype) { * retrieving environment variables to be passed * between shells. * - * @return a HashMap instance. + * @return a {@code HashMap} instance. */ public Map getEnvironment() { return environment; diff --git a/remote-telnet/src/main/java/org/jline/builtins/telnet/ConnectionManager.java b/remote-telnet/src/main/java/org/jline/builtins/telnet/ConnectionManager.java index 6d9c7cf78..e63e37064 100644 --- a/remote-telnet/src/main/java/org/jline/builtins/telnet/ConnectionManager.java +++ b/remote-telnet/src/main/java/org/jline/builtins/telnet/ConnectionManager.java @@ -115,7 +115,7 @@ public void setConnectionFilter(ConnectionFilter filter) { /** * Returns the number of open connections. - * @return the number of open connections as int. + * @return the number of open connections as {@code int}. */ public int openConnectionCount() { return openConnections.size(); @@ -134,11 +134,11 @@ public Connection getConnection(int idx) { /** * Get all {@link Connection} instances with the given - * InetAddress. + * {@code InetAddress}. * * @param addr the address * @return all {@link Connection} instances with the given - * InetAddress. + * {@code InetAddress}. */ public Connection[] getConnectionsByAdddress(InetAddress addr) { ArrayList l = new ArrayList(); @@ -154,7 +154,7 @@ public Connection[] getConnectionsByAdddress(InetAddress addr) { }//getConnectionsByAddress /** - * Starts this ConnectionManager. + * Starts this {@code ConnectionManager}. */ public void start() { thread = new Thread(this); @@ -162,7 +162,7 @@ public void start() { }//start /** - * Stops this ConnectionManager. + * Stops this {@code ConnectionManager}. */ public void stop() { LOG.log(Level.FINE, "stop()::" + this.toString()); diff --git a/remote-telnet/src/main/java/org/jline/builtins/telnet/PortListener.java b/remote-telnet/src/main/java/org/jline/builtins/telnet/PortListener.java index d645410bb..5e242b831 100644 --- a/remote-telnet/src/main/java/org/jline/builtins/telnet/PortListener.java +++ b/remote-telnet/src/main/java/org/jline/builtins/telnet/PortListener.java @@ -50,9 +50,9 @@ import java.util.logging.Logger; /** - * Class that implements a PortListener.
+ * Class that implements a {@code PortListener}.
* If available, it accepts incoming connections and passes them - * to an associated ConnectionManager. + * to an associated {@code ConnectionManager}. * * @author Dieter Wimberger * @version 2.0 (16/07/2006) @@ -91,16 +91,16 @@ public PortListener(String name, String ip, int port, int floodprot) { }//constructor /** - * Returns the name of this PortListener. + * Returns the name of this {@code PortListener}. * - * @return the name as String. + * @return the name as {@code String}. */ public String getName() { return name; }//getName /** - * Tests if this PortListener is available. + * Tests if this {@code PortListener} is available. * * @return true if available, false otherwise. */ @@ -109,7 +109,7 @@ public boolean isAvailable() { }//isAvailable /** - * Sets the availability flag of this PortListener. + * Sets the availability flag of this {@code PortListener}. * * @param b true if to be available, false otherwise. */ @@ -118,7 +118,7 @@ public void setAvailable(boolean b) { }//setAvailable /** - * Starts this PortListener. + * Starts this {@code PortListener}. */ public void start() { LOG.log(Level.FINE, "start()"); @@ -128,7 +128,7 @@ public void start() { }//start /** - * Stops this PortListener, and returns + * Stops this {@code PortListener}, and returns * when everything was stopped successfully. */ public void stop() {