Skip to content

Commit

Permalink
Fix javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
gnodet committed Mar 8, 2023
1 parent cc021a5 commit 0eddc13
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 16 deletions.
4 changes: 2 additions & 2 deletions reader/src/main/java/org/jline/reader/LineReader.java
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

/** Read lines from the console, with input editing.
*
* <h3>Thread safety</h3>
* <h2>Thread safety</h2>
* The <code>LineReader</code> 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 <code>readLine</code> call while one is
Expand All @@ -31,7 +31,7 @@
* {@link #printAbove(String)} or {@link #printAbove(AttributedString)} at
* any time to allow text to be printed above the current prompt.
*
* <h3>Prompt strings</h3>
* <h2>Prompt strings</h2>
* 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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,7 @@ public void setNegotiatedTerminalType(String termtype) {
* retrieving environment variables to be passed
* between shells.
*
* @return a <tt>HashMap</tt> instance.
* @return a {@code HashMap} instance.
*/
public Map<String, String> getEnvironment() {
return environment;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ public void setConnectionFilter(ConnectionFilter filter) {

/**
* Returns the number of open connections.
* @return the number of open connections as <tt>int</tt>.
* @return the number of open connections as {@code int}.
*/
public int openConnectionCount() {
return openConnections.size();
Expand All @@ -134,11 +134,11 @@ public Connection getConnection(int idx) {

/**
* Get all {@link Connection} instances with the given
* <tt>InetAddress</tt>.
* {@code InetAddress}.
*
* @param addr the address
* @return all {@link Connection} instances with the given
* <tt>InetAddress</tt>.
* {@code InetAddress}.
*/
public Connection[] getConnectionsByAdddress(InetAddress addr) {
ArrayList<Connection> l = new ArrayList<Connection>();
Expand All @@ -154,15 +154,15 @@ public Connection[] getConnectionsByAdddress(InetAddress addr) {
}//getConnectionsByAddress

/**
* Starts this <tt>ConnectionManager</tt>.
* Starts this {@code ConnectionManager}.
*/
public void start() {
thread = new Thread(this);
thread.start();
}//start

/**
* Stops this <tt>ConnectionManager</tt>.
* Stops this {@code ConnectionManager}.
*/
public void stop() {
LOG.log(Level.FINE, "stop()::" + this.toString());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@
import java.util.logging.Logger;

/**
* Class that implements a <tt>PortListener</tt>.<br>
* Class that implements a {@code PortListener}.<br>
* If available, it accepts incoming connections and passes them
* to an associated <tt>ConnectionManager</tt>.
* to an associated {@code ConnectionManager}.
*
* @author Dieter Wimberger
* @version 2.0 (16/07/2006)
Expand Down Expand Up @@ -91,16 +91,16 @@ public PortListener(String name, String ip, int port, int floodprot) {
}//constructor

/**
* Returns the name of this <tt>PortListener</tt>.
* Returns the name of this {@code PortListener}.
*
* @return the name as <tt>String</tt>.
* @return the name as {@code String}.
*/
public String getName() {
return name;
}//getName

/**
* Tests if this <tt>PortListener</tt> is available.
* Tests if this {@code PortListener} is available.
*
* @return true if available, false otherwise.
*/
Expand All @@ -109,7 +109,7 @@ public boolean isAvailable() {
}//isAvailable

/**
* Sets the availability flag of this <tt>PortListener</tt>.
* Sets the availability flag of this {@code PortListener}.
*
* @param b true if to be available, false otherwise.
*/
Expand All @@ -118,7 +118,7 @@ public void setAvailable(boolean b) {
}//setAvailable

/**
* Starts this <tt>PortListener</tt>.
* Starts this {@code PortListener}.
*/
public void start() {
LOG.log(Level.FINE, "start()");
Expand All @@ -128,7 +128,7 @@ public void start() {
}//start

/**
* Stops this <tt>PortListener</tt>, and returns
* Stops this {@code PortListener}, and returns
* when everything was stopped successfully.
*/
public void stop() {
Expand Down

0 comments on commit 0eddc13

Please sign in to comment.