Skip to content

Commit

Permalink
Javadoc: Remove unnecessary open paragraph tag
Browse files Browse the repository at this point in the history
Format Javadoc class comment
  • Loading branch information
garydgregory committed Nov 29, 2024
1 parent a6d3b34 commit fac70d0
Showing 1 changed file with 5 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -54,21 +54,19 @@ public class SftpStreamProxy implements Proxy {
/**
* Command pattern to execute on the proxy host.
* <p>
* When run, the command output should be forwarded to the target host and port, and its input should be forwarded
* from the target host and port.
* When run, the command output should be forwarded to the target host and port, and its input should be forwarded from the target host and port.
* </p>
* <p>
* The command will be created for each host/port pair by using {@linkplain String#format(String, Object...)} with
* two objects: the target host name ({@linkplain String}) and the target port ({@linkplain Integer}).
* The command will be created for each host/port pair by using {@linkplain String#format(String, Object...)} with two objects: the target host name
* ({@linkplain String}) and the target port ({@linkplain Integer}).
* </p>
* <p>
* <p>
* Here are two examples (that can be easily used by using the static members of this class):
* </p>
* <ul>
* <li>{@code nc -q 0 %s %d} to use the netcat command ({@linkplain #NETCAT_COMMAND})</li>
* <li>{@code /bin/bash -c 'exec 3<>/dev/tcp/%s/%d; cat <&3 & cat >&3; kill $!} will use bash built-in TCP
* stream, which can be useful when there is no netcat available. ({@linkplain #BASH_TCP_COMMAND})</li>
* <li>{@code /bin/bash -c 'exec 3<>/dev/tcp/%s/%d; cat <&3 & cat >&3; kill $!} will use bash built-in TCP stream, which can be useful when there is no
* netcat available. ({@linkplain #BASH_TCP_COMMAND})</li>
* </ul>
*/
private final String commandFormat;
Expand Down

0 comments on commit fac70d0

Please sign in to comment.