Skip to content

Commit 2ec336a

Browse files
tomaswolftomaswolf
committed
Fix javadoc warnings
1 parent 92eb158 commit 2ec336a

19 files changed

Lines changed: 31 additions & 84 deletions

File tree

‎sshd-common/src/main/java/org/apache/sshd/client/auth/password/PasswordIdentityProvider.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
public interface PasswordIdentityProvider {
3737

3838
/**
39-
* An "empty&quot implementation of {@link PasswordIdentityProvider} that returns an empty group of passwords
39+
* An empty implementation of {@link PasswordIdentityProvider} that returns an empty group of passwords.
4040
*/
4141
PasswordIdentityProvider EMPTY_PASSWORDS_PROVIDER = new PasswordIdentityProvider() {
4242
@Override

‎sshd-common/src/main/java/org/apache/sshd/common/config/keys/KeyUtils.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -766,8 +766,8 @@ public static String getFingerPrint(Digest d, String s, Charset charset) {
766766
* @param expected The expected fingerprint if {@code null} or empty then returns a failure with the default
767767
* fingerprint.
768768
* @param key the {@link PublicKey} - if {@code null} then returns null.
769-
* @return SimpleImmutableEntry<Boolean, String> - key is success indicator, value is actual fingerprint,
770-
* {@code null} if no key.
769+
* @return SimpleImmutableEntry&lt;Boolean, String> - key is success indicator, value is actual
770+
* fingerprint, {@code null} if no key.
771771
* @see #getDefaultFingerPrintFactory()
772772
* @see #checkFingerPrint(String, Factory, PublicKey)
773773
*/
@@ -780,8 +780,8 @@ public static SimpleImmutableEntry<Boolean, String> checkFingerPrint(String expe
780780
* fingerprint.
781781
* @param f The {@link Factory} to be used to generate the default {@link Digest} for the key
782782
* @param key the {@link PublicKey} - if {@code null} then returns null.
783-
* @return SimpleImmutableEntry<Boolean, String> - key is success indicator, value is actual fingerprint,
784-
* {@code null} if no key.
783+
* @return SimpleImmutableEntry&lt;Boolean, String> - key is success indicator, value is actual
784+
* fingerprint, {@code null} if no key.
785785
*/
786786
public static SimpleImmutableEntry<Boolean, String> checkFingerPrint(
787787
String expected, Factory<? extends Digest> f, PublicKey key) {
@@ -793,8 +793,8 @@ public static SimpleImmutableEntry<Boolean, String> checkFingerPrint(
793793
* fingerprint.
794794
* @param d The {@link Digest} to be used to generate the default fingerprint for the key
795795
* @param key the {@link PublicKey} - if {@code null} then returns null.
796-
* @return SimpleImmutableEntry<Boolean, String> - key is success indicator, value is actual fingerprint,
797-
* {@code null} if no key.
796+
* @return SimpleImmutableEntry&lt;Boolean, String> - key is success indicator, value is actual
797+
* fingerprint, {@code null} if no key.
798798
*/
799799
public static SimpleImmutableEntry<Boolean, String> checkFingerPrint(String expected, Digest d, PublicKey key) {
800800
if (key == null) {

‎sshd-common/src/main/java/org/apache/sshd/common/util/GenericUtils.java‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -113,10 +113,6 @@ public static String replaceWhitespaceAndTrim(String s) {
113113
* @param with String to replace with
114114
* @param max maximum number of values to replace, or <code>-1</code> if no maximum
115115
* @return the text with any replacements processed
116-
* @author Arnout J. Kuiper <a href="mailto:ajkuiper@wxs.nl">ajkuiper@wxs.nl</a>
117-
* @author Magesh Umasankar
118-
* @author <a href="mailto:bruce@callenish.com">Bruce Atherton</a>
119-
* @author <a href="mailto:levylambert@tiscali-dsl.de">Antoine Levy-Lambert</a>
120116
*/
121117
@SuppressWarnings("PMD.AssignmentInOperand")
122118
public static String replace(String text, String repl, String with, int max) {

‎sshd-common/src/main/java/org/apache/sshd/common/util/OsUtils.java‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,26 +37,26 @@ public final class OsUtils {
3737

3838
/**
3939
* Property that can be used to override the reported value from {@link #getCurrentUser()}. If not set then
40-
* &quot;user.name&quot; system property is used
40+
* "user.name" system property is used.
4141
*/
4242
public static final String CURRENT_USER_OVERRIDE_PROP = "org.apache.sshd.currentUser";
4343

4444
/**
4545
* Property that can be used to override the reported value from {@link #getJavaVersion()}. If not set then
46-
* &quot;java.version&quot; system property is used
46+
* "java.version" system property is used.
4747
*/
4848
public static final String JAVA_VERSION_OVERRIDE_PROP = "org.apache.sshd.javaVersion";
4949

5050
/**
51-
* Property that can be used to override the reported value from {@link #isWin32()}. If not set then
52-
* &quot;os.name&quot; system property is used
51+
* Property that can be used to override the reported value from {@link #isWin32()}. If not set then "os.name"
52+
* system property is used.
5353
*/
5454
public static final String OS_TYPE_OVERRIDE_PROP = "org.apache.sshd.osType";
5555

5656
/**
5757
* Property that can be used to override the reported value from {@link #isAndroid()}. If not set then
5858
* {@link #ANDROID_DETECTION_PROPERTIES} are used to determine its value. Otherwise, it must contain the string
59-
* &quot;android&quot; (case-insensitive)
59+
* "android" (case-insensitive).
6060
*
6161
* @see #ANDROID_PROPERTY_VALUE_MATCHER
6262
*/
@@ -65,7 +65,7 @@ public final class OsUtils {
6565
/**
6666
* Property that can be used to override the reported value from {@link #isDalvikMachine()}. If not set then
6767
* {@link #DALVIK_DETECTION_PROPERTIES} are used to determine its value. Otherwise, it must contain the string
68-
* &quot;dalvik&quot; (case-insensitive)
68+
* "dalvik" (case-insensitive).
6969
*/
7070
public static final String DALVIK_MACHINE_OVERRIDE_PROP = "org.apache.sshd.dalvikMachine";
7171

@@ -335,7 +335,7 @@ public static String getCurrentUser() {
335335
}
336336

337337
/**
338-
* Remove {@code Windows} domain and/or group prefix as well as &quot;(User);&quot suffix
338+
* Remove {@code Windows} domain and/or group prefix as well as "(User)" suffix
339339
*
340340
* @param user The original username - ignored if {@code null}/empty
341341
* @return The canonical user - unchanged if {@code Unix} O/S

‎sshd-common/src/main/java/org/apache/sshd/common/util/buffer/keys/BufferPublicKeyParser.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,13 +64,13 @@ public String toString() {
6464
SkED25519BufferPublicKeyParser.INSTANCE));
6565

6666
/**
67-
* @param keyType The key type - e.g., &quot;ssh-rsa&quot, &quot;ssh-dss&quot;
67+
* @param keyType The key type - e.g., "ssh-rsa", "ssh-dss", etc
6868
* @return {@code true} if this key type is supported by the parser
6969
*/
7070
boolean isKeyTypeSupported(String keyType);
7171

7272
/**
73-
* @param keyType The key type - e.g., &quot;ssh-rsa&quot, &quot;ssh-dss&quot;
73+
* @param keyType The key type - e.g., "ssh-rsa", "ssh-dss", etc
7474
* @param buffer The {@link Buffer} containing the encoded raw public key
7575
* @return The decoded {@link PublicKey}
7676
* @throws GeneralSecurityException If failed to generate the key

‎sshd-common/src/main/java/org/apache/sshd/common/util/io/der/DERWriter.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ public void writeBigInteger(BigInteger value) throws IOException {
7676
}
7777

7878
/**
79-
* The integer is always considered to be positive, so if the first byte is < 0, we pad with a zero to make it
79+
* The integer is always considered to be positive, so if the first byte is &lt; 0, we pad with a zero to make it
8080
* positive
8181
*
8282
* @param bytes {@link BigInteger} bytes
@@ -87,7 +87,7 @@ public void writeBigInteger(byte... bytes) throws IOException {
8787
}
8888

8989
/**
90-
* The integer is always considered to be positive, so if the first byte is < 0, we pad with a zero to make it
90+
* The integer is always considered to be positive, so if the first byte is &lt; 0, we pad with a zero to make it
9191
* positive
9292
*
9393
* @param bytes {@link BigInteger} bytes

‎sshd-common/src/main/java/org/apache/sshd/common/util/security/SecurityUtils.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,8 +122,8 @@ public final class SecurityUtils {
122122

123123
/**
124124
* The min. key size value used for testing whether Diffie-Hellman Group Exchange is supported or not. According to
125-
* <A HREF="https://tools.ietf.org/html/rfc4419">RFC 4419</A> section 3: &quot;Servers and clients SHOULD support
126-
* groups with a modulus length of k bits, where 1024 <= k <= 8192&quot;. </code>
125+
* <A HREF="https://tools.ietf.org/html/rfc4419">RFC 4419</A> section 3: <em>Servers and clients SHOULD support
126+
* groups with a modulus length of k bits, where 1024 &lt;= k &lt;= 8192.</em>
127127
*
128128
* <B>Note: this has been amended by <A HREF="https://tools.ietf.org/html/rfc8270">RFC 8270</A>
129129
*/

‎sshd-core/src/main/java/org/apache/sshd/client/session/ClientProxyConnector.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424
/**
2525
* Provides a way to implement proxied connections where some metadata about the client is sent <U>before</U> the actual
26-
* SSH protocol is executed - e.g., the <A HREF=@http://www.haproxy.org/download/1.6/doc/proxy-protocol.txt">PROXY
26+
* SSH protocol is executed - e.g., the <A HREF="http://www.haproxy.org/download/1.6/doc/proxy-protocol.txt">PROXY
2727
* protocol</A>. The implementor should use the {@code IoSession#write(Buffer)} method to send any packets with the
2828
* meta-data.
2929
*

‎sshd-core/src/main/java/org/apache/sshd/common/session/Session.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -224,11 +224,11 @@ default Buffer request(String request, Buffer buffer, Duration timeout) throws I
224224
* {@link Buffer} to the given {@link ReplyHandler}, which may execute in a different thread.
225225
*
226226
* <dl>
227-
* <dt>want-reply == true && replyHandler != null</dt>
227+
* <dt>want-reply == true &amp;&amp; replyHandler != null</dt>
228228
* <dd>The returned future is fulfilled with {@code null} when the request was sent, or with an exception if the
229229
* request could not be sent. The {@code replyHandler} is invoked once the reply is received, with the SSH reply
230230
* code and the data received.</dd>
231-
* <dt>want-reply == true && replyHandler == null</dt>
231+
* <dt>want-reply == true &amp;&amp; replyHandler == null</dt>
232232
* <dd>The returned future is fulfilled with an exception if the request could not be sent, or a failure reply was
233233
* received. If a success reply was received, the future is fulfilled with the received data buffer.</dd>
234234
* <dt>want-reply == false</dt>

‎sshd-core/src/main/java/org/apache/sshd/server/session/ServerProxyAcceptor.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424
/**
2525
* Provides a way to implement proxied connections where some metadata about the client is sent <U>before</U> the actual
26-
* SSH protocol is executed - e.g., the <A HREF=@http://www.haproxy.org/download/1.6/doc/proxy-protocol.txt">PROXY
26+
* SSH protocol is executed - e.g., the <A HREF="http://www.haproxy.org/download/1.6/doc/proxy-protocol.txt">PROXY
2727
* protocol</A>.
2828
*
2929
* @author <a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a>

0 commit comments

Comments
 (0)