Cleared some JavaDoc warnings

This commit is contained in:
Jeroen van Erp
2015-06-16 14:12:36 +02:00
parent 7c26ac669a
commit 97065264de
3 changed files with 6 additions and 6 deletions

View File

@@ -9,7 +9,7 @@ public class Sockets {
/** /**
* Java 7 and up have Socket implemented as Closeable, whereas Java6 did not have this inheritance. * Java 7 and up have Socket implemented as Closeable, whereas Java6 did not have this inheritance.
* @param socket The socket to wrap as Closeable * @param socket The socket to wrap as Closeable
* @return * @return The (potentially wrapped) Socket as a Closeable.
*/ */
public static Closeable asCloseable(final Socket socket) { public static Closeable asCloseable(final Socket socket) {
if (Closeable.class.isAssignableFrom(socket.getClass())) { if (Closeable.class.isAssignableFrom(socket.getClass())) {

View File

@@ -61,7 +61,7 @@ public abstract class SocketClient {
* @param port The port to connect to. * @param port The port to connect to.
* @param proxy The proxy to connect via. * @param proxy The proxy to connect via.
* @deprecated This method will be removed after v0.12.0. If you want to connect via a proxy, you can do this by injecting a {@link javax.net.SocketFactory} * @deprecated This method will be removed after v0.12.0. If you want to connect via a proxy, you can do this by injecting a {@link javax.net.SocketFactory}
* into the SocketClient. The SocketFactory should create sockets using the {@link java.net.Socket(java.net.Proxy)} constructor. * into the SocketClient. The SocketFactory should create sockets using the {@link java.net.Socket#Socket(java.net.Proxy)} constructor.
*/ */
@Deprecated @Deprecated
public void connect(InetAddress host, int port, Proxy proxy) throws IOException { public void connect(InetAddress host, int port, Proxy proxy) throws IOException {
@@ -86,7 +86,7 @@ public abstract class SocketClient {
* @param port The port to connect to. * @param port The port to connect to.
* @param proxy The proxy to connect via. * @param proxy The proxy to connect via.
* @deprecated This method will be removed after v0.12.0. If you want to connect via a proxy, you can do this by injecting a {@link javax.net.SocketFactory} * @deprecated This method will be removed after v0.12.0. If you want to connect via a proxy, you can do this by injecting a {@link javax.net.SocketFactory}
* into the SocketClient. The SocketFactory should create sockets using the {@link java.net.Socket(java.net.Proxy)} constructor. * into the SocketClient. The SocketFactory should create sockets using the {@link java.net.Socket#Socket(java.net.Proxy)} constructor.
*/ */
@Deprecated @Deprecated
public void connect(String hostname, int port, Proxy proxy) throws IOException { public void connect(String hostname, int port, Proxy proxy) throws IOException {
@@ -120,7 +120,7 @@ public abstract class SocketClient {
* @param host The host address to connect to. * @param host The host address to connect to.
* @param proxy The proxy to connect via. * @param proxy The proxy to connect via.
* @deprecated This method will be removed after v0.12.0. If you want to connect via a proxy, you can do this by injecting a {@link javax.net.SocketFactory} * @deprecated This method will be removed after v0.12.0. If you want to connect via a proxy, you can do this by injecting a {@link javax.net.SocketFactory}
* into the SocketClient. The SocketFactory should create sockets using the {@link java.net.Socket(java.net.Proxy)} constructor. * into the SocketClient. The SocketFactory should create sockets using the {@link java.net.Socket#Socket(java.net.Proxy)} constructor.
*/ */
@Deprecated @Deprecated
public void connect(InetAddress host, Proxy proxy) throws IOException { public void connect(InetAddress host, Proxy proxy) throws IOException {
@@ -132,7 +132,7 @@ public abstract class SocketClient {
* @param hostname The host name to connect to. * @param hostname The host name to connect to.
* @param proxy The proxy to connect via. * @param proxy The proxy to connect via.
* @deprecated This method will be removed after v0.12.0. If you want to connect via a proxy, you can do this by injecting a {@link javax.net.SocketFactory} * @deprecated This method will be removed after v0.12.0. If you want to connect via a proxy, you can do this by injecting a {@link javax.net.SocketFactory}
* into the SocketClient. The SocketFactory should create sockets using the {@link java.net.Socket(java.net.Proxy)} constructor. * into the SocketClient. The SocketFactory should create sockets using the {@link java.net.Socket#Socket(java.net.Proxy)} constructor.
*/ */
@Deprecated @Deprecated
public void connect(String hostname, Proxy proxy) throws IOException { public void connect(String hostname, Proxy proxy) throws IOException {

View File

@@ -66,7 +66,7 @@ public class ConnectionImpl
* *
* @param config the ssh config * @param config the ssh config
* @param trans transport layer * @param trans transport layer
* @param keepAlive * @param keepAlive the keep alive provider
*/ */
public ConnectionImpl(Transport trans, KeepAliveProvider keepAlive) { public ConnectionImpl(Transport trans, KeepAliveProvider keepAlive) {
super("ssh-connection", trans); super("ssh-connection", trans);