You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mina.apache.org by lg...@apache.org on 2018/12/18 07:27:58 UTC
[14/15] mina-sshd git commit: Updated Maven Javadoc plugin
configuration
Updated Maven Javadoc plugin configuration
Project: http://git-wip-us.apache.org/repos/asf/mina-sshd/repo
Commit: http://git-wip-us.apache.org/repos/asf/mina-sshd/commit/c78f10c7
Tree: http://git-wip-us.apache.org/repos/asf/mina-sshd/tree/c78f10c7
Diff: http://git-wip-us.apache.org/repos/asf/mina-sshd/diff/c78f10c7
Branch: refs/heads/master
Commit: c78f10c7a62e9a3de716079c51a9fef646d7ad17
Parents: fc94653
Author: Lyor Goldstein <lg...@apache.org>
Authored: Tue Dec 18 01:44:03 2018 +0200
Committer: Lyor Goldstein <lg...@apache.org>
Committed: Tue Dec 18 09:27:39 2018 +0200
----------------------------------------------------------------------
pom.xml | 8 +++++++-
.../java/org/apache/sshd/common/PropertyResolverUtils.java | 4 ++--
.../org/apache/sshd/common/future/AbstractSshFuture.java | 2 +-
.../org/apache/sshd/common/future/DefaultCloseFuture.java | 2 +-
.../java/org/apache/sshd/common/future/DefaultSshFuture.java | 2 +-
.../java/org/apache/sshd/common/future/WaitableFuture.java | 2 +-
.../main/java/org/apache/sshd/common/channel/Channel.java | 2 +-
.../org/apache/sshd/common/io/IoServiceEventListener.java | 2 +-
.../main/java/org/apache/sshd/common/session/Session.java | 2 +-
.../server/auth/pubkey/KeySetPublickeyAuthenticator.java | 2 +-
.../sshd/server/auth/pubkey/PublickeyAuthenticator.java | 2 +-
11 files changed, 18 insertions(+), 12 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/c78f10c7/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index 86d700d..a97cb4c 100644
--- a/pom.xml
+++ b/pom.xml
@@ -88,6 +88,7 @@
<java.major.version>1</java.major.version>
<java.minor.version>8</java.minor.version>
+ <java.sdk.version>8</java.sdk.version>
<sniffer.signatures.version>1.0</sniffer.signatures.version>
<javac.source>${java.major.version}.${java.minor.version}</javac.source>
<project.build.java.source>${javac.source}</project.build.java.source>
@@ -729,7 +730,12 @@
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.0.1</version>
<configuration>
- <additionalOptions>-Xdoclint:none </additionalOptions>
+ <additionalOptions>-Xdoclint:-missing</additionalOptions>
+ <encoding>${project.build.sourceEncoding}</encoding>
+ <quiet>true</quiet>
+ <links>
+ <link>http://docs.oracle.com/javase/${java.sdk.version}/docs/api</link>
+ </links>
</configuration>
<dependencies>
<dependency>
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/c78f10c7/sshd-common/src/main/java/org/apache/sshd/common/PropertyResolverUtils.java
----------------------------------------------------------------------
diff --git a/sshd-common/src/main/java/org/apache/sshd/common/PropertyResolverUtils.java b/sshd-common/src/main/java/org/apache/sshd/common/PropertyResolverUtils.java
index 79fb451..d95278b 100644
--- a/sshd-common/src/main/java/org/apache/sshd/common/PropertyResolverUtils.java
+++ b/sshd-common/src/main/java/org/apache/sshd/common/PropertyResolverUtils.java
@@ -83,7 +83,7 @@ public final class PropertyResolverUtils {
* </LI>
*
* <LI>
- * Otherwise, the value's {@link #toString()} is parsed as a {@code long}
+ * Otherwise, the value's {@code toString()} is parsed as a {@code long}
* </LI>
* </UL>
*
@@ -135,7 +135,7 @@ public final class PropertyResolverUtils {
* </LI>
*
* <LI>
- * Otherwise, the value's {@link #toString()} is parsed as a {@link Long}
+ * Otherwise, the value's {@code toString()} is parsed as a {@link Long}
* </LI>
* </UL>
*
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/c78f10c7/sshd-common/src/main/java/org/apache/sshd/common/future/AbstractSshFuture.java
----------------------------------------------------------------------
diff --git a/sshd-common/src/main/java/org/apache/sshd/common/future/AbstractSshFuture.java b/sshd-common/src/main/java/org/apache/sshd/common/future/AbstractSshFuture.java
index 1dca54c..e727560 100644
--- a/sshd-common/src/main/java/org/apache/sshd/common/future/AbstractSshFuture.java
+++ b/sshd-common/src/main/java/org/apache/sshd/common/future/AbstractSshFuture.java
@@ -43,7 +43,7 @@ public abstract class AbstractSshFuture<T extends SshFuture> extends AbstractLog
private final Object id;
/**
- * @param id Some identifier useful as {@link #toString()} value
+ * @param id Some identifier useful as {@code toString()} value
*/
protected AbstractSshFuture(Object id) {
this.id = id;
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/c78f10c7/sshd-common/src/main/java/org/apache/sshd/common/future/DefaultCloseFuture.java
----------------------------------------------------------------------
diff --git a/sshd-common/src/main/java/org/apache/sshd/common/future/DefaultCloseFuture.java b/sshd-common/src/main/java/org/apache/sshd/common/future/DefaultCloseFuture.java
index 4c34a06..d183269 100644
--- a/sshd-common/src/main/java/org/apache/sshd/common/future/DefaultCloseFuture.java
+++ b/sshd-common/src/main/java/org/apache/sshd/common/future/DefaultCloseFuture.java
@@ -28,7 +28,7 @@ public class DefaultCloseFuture extends DefaultSshFuture<CloseFuture> implements
/**
* Create a new instance
*
- * @param id Some identifier useful as {@link #toString()} value
+ * @param id Some identifier useful as {@code toString()} value
* @param lock A synchronization object for locking access - if {@code null}
* then synchronization occurs on {@code this} instance
*/
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/c78f10c7/sshd-common/src/main/java/org/apache/sshd/common/future/DefaultSshFuture.java
----------------------------------------------------------------------
diff --git a/sshd-common/src/main/java/org/apache/sshd/common/future/DefaultSshFuture.java b/sshd-common/src/main/java/org/apache/sshd/common/future/DefaultSshFuture.java
index cd475ff..eb3ea42 100644
--- a/sshd-common/src/main/java/org/apache/sshd/common/future/DefaultSshFuture.java
+++ b/sshd-common/src/main/java/org/apache/sshd/common/future/DefaultSshFuture.java
@@ -42,7 +42,7 @@ public class DefaultSshFuture<T extends SshFuture> extends AbstractSshFuture<T>
/**
* Creates a new instance.
*
- * @param id Some identifier useful as {@link #toString()} value
+ * @param id Some identifier useful as {@code toString()} value
* @param lock A synchronization object for locking access - if {@code null}
* then synchronization occurs on {@code this} instance
*/
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/c78f10c7/sshd-common/src/main/java/org/apache/sshd/common/future/WaitableFuture.java
----------------------------------------------------------------------
diff --git a/sshd-common/src/main/java/org/apache/sshd/common/future/WaitableFuture.java b/sshd-common/src/main/java/org/apache/sshd/common/future/WaitableFuture.java
index aff4adc..dea5234 100644
--- a/sshd-common/src/main/java/org/apache/sshd/common/future/WaitableFuture.java
+++ b/sshd-common/src/main/java/org/apache/sshd/common/future/WaitableFuture.java
@@ -33,7 +33,7 @@ import java.util.concurrent.TimeUnit;
*/
public interface WaitableFuture {
/**
- * @return Some identifier useful as {@link #toString()} value
+ * @return Some identifier useful as {@code toString()} value
*/
Object getId();
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/c78f10c7/sshd-core/src/main/java/org/apache/sshd/common/channel/Channel.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/channel/Channel.java b/sshd-core/src/main/java/org/apache/sshd/common/channel/Channel.java
index 258642e..4fe1dbe 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/channel/Channel.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/channel/Channel.java
@@ -227,7 +227,7 @@ public interface Channel
* @param key The attribute key - never {@code null}
* @return Associated value - {@code null} if not found
* @see #getSession()
- * @see Session#resolveAttribute(Session, AttributeKey)
+ * @see Session#resolveAttribute(Session, AttributeRepository.AttributeKey)
*/
static <T> T resolveAttribute(Channel channel, AttributeRepository.AttributeKey<T> key) {
Objects.requireNonNull(key, "No key");
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/c78f10c7/sshd-core/src/main/java/org/apache/sshd/common/io/IoServiceEventListener.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/io/IoServiceEventListener.java b/sshd-core/src/main/java/org/apache/sshd/common/io/IoServiceEventListener.java
index e58bd7f..b98209e 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/io/IoServiceEventListener.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/io/IoServiceEventListener.java
@@ -91,7 +91,7 @@ public interface IoServiceEventListener extends SshdEventListener {
* @param remote The remote connection endpoint
* @param service The service listen endpoint through which the connection was accepted
* @param reason The reason for aborting - may be an exception thrown by
- * {@link #connectionAccepted(IoAcceptor, SocketAddress, SocketAddress) connectionAccepted}
+ * {@link #connectionAccepted(IoAcceptor, SocketAddress, SocketAddress, SocketAddress) connectionAccepted}
* @throws IOException If failed to handle the event - the exception is logged but does not
* prevent further connections from being accepted
*/
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/c78f10c7/sshd-core/src/main/java/org/apache/sshd/common/session/Session.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/common/session/Session.java b/sshd-core/src/main/java/org/apache/sshd/common/session/Session.java
index 8c094cd..90f2885 100644
--- a/sshd-core/src/main/java/org/apache/sshd/common/session/Session.java
+++ b/sshd-core/src/main/java/org/apache/sshd/common/session/Session.java
@@ -321,7 +321,7 @@ public interface Session
* @param key The attribute key - never {@code null}
* @return Associated value - {@code null} if not found
* @see Session#getFactoryManager()
- * @see FactoryManager#resolveAttribute(FactoryManager, AttributeKey)
+ * @see FactoryManager#resolveAttribute(FactoryManager, AttributeRepository.AttributeKey)
*/
static <T> T resolveAttribute(Session session, AttributeRepository.AttributeKey<T> key) {
Objects.requireNonNull(key, "No key");
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/c78f10c7/sshd-core/src/main/java/org/apache/sshd/server/auth/pubkey/KeySetPublickeyAuthenticator.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/server/auth/pubkey/KeySetPublickeyAuthenticator.java b/sshd-core/src/main/java/org/apache/sshd/server/auth/pubkey/KeySetPublickeyAuthenticator.java
index 3c70f2e..cdb62ad 100644
--- a/sshd-core/src/main/java/org/apache/sshd/server/auth/pubkey/KeySetPublickeyAuthenticator.java
+++ b/sshd-core/src/main/java/org/apache/sshd/server/auth/pubkey/KeySetPublickeyAuthenticator.java
@@ -41,7 +41,7 @@ public class KeySetPublickeyAuthenticator extends AbstractLoggingBean implements
}
/**
- * @return Some kind of mnemonic identifier for the authenticator - used also in {@link #toString()}
+ * @return Some kind of mnemonic identifier for the authenticator - used also in {@code toString()}
*/
public Object getId() {
return id;
http://git-wip-us.apache.org/repos/asf/mina-sshd/blob/c78f10c7/sshd-core/src/main/java/org/apache/sshd/server/auth/pubkey/PublickeyAuthenticator.java
----------------------------------------------------------------------
diff --git a/sshd-core/src/main/java/org/apache/sshd/server/auth/pubkey/PublickeyAuthenticator.java b/sshd-core/src/main/java/org/apache/sshd/server/auth/pubkey/PublickeyAuthenticator.java
index 3e42159..d2d564a 100644
--- a/sshd-core/src/main/java/org/apache/sshd/server/auth/pubkey/PublickeyAuthenticator.java
+++ b/sshd-core/src/main/java/org/apache/sshd/server/auth/pubkey/PublickeyAuthenticator.java
@@ -51,7 +51,7 @@ public interface PublickeyAuthenticator {
boolean authenticate(String username, PublicKey key, ServerSession session) throws AsyncAuthException;
/**
- * @param id Some kind of mnemonic identifier for the authenticator - used also in {@link #toString()}
+ * @param id Some kind of mnemonic identifier for the authenticator - used also in {@code toString()}
* @param session The {@link ServerSession} that triggered this call - may be {@code null} if invoked
* by offline tool (e.g., unit test) or session context unknown to caller.
* @param entries The entries to parse - ignored if {@code null}/empty