JavaDoc fixes

Signed-off-by: Maxim Nesen <[email protected]>
eclipse-ee4j · Dec 21, 2021 · 519e167 · 519e167
1 parent 93d642e
commit 519e167
Show file tree

Hide file tree

Showing 9 changed files with 66 additions and 66 deletions.
diff --git a/client/src/main/java/org/glassfish/tyrus/client/SslContextConfigurator.java b/client/src/main/java/org/glassfish/tyrus/client/SslContextConfigurator.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2007, 2017 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2007, 2021 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0, which is available at
@@ -67,7 +67,7 @@ public class SslContextConfigurator {
      * <p>
      * No default value is set.
      * <p>
-     * The name of the configuration property is <tt>{@value}</tt>.
+     * The name of the configuration property is <code>{@value}</code>.
      */
     public static final String TRUST_STORE_PROVIDER = "javax.net.ssl.trustStoreProvider";
     /**
@@ -77,7 +77,7 @@ public class SslContextConfigurator {
      * <p>
      * No default value is set.
      * <p>
-     * The name of the configuration property is <tt>{@value}</tt>.
+     * The name of the configuration property is <code>{@value}</code>.
      */
     public static final String KEY_STORE_PROVIDER = "javax.net.ssl.keyStoreProvider";
     /**
@@ -87,7 +87,7 @@ public class SslContextConfigurator {
      * <p>
      * No default value is set.
      * <p>
-     * The name of the configuration property is <tt>{@value}</tt>.
+     * The name of the configuration property is <code>{@value}</code>.
      */
     public static final String TRUST_STORE_FILE = "javax.net.ssl.trustStore";
     /**
@@ -97,7 +97,7 @@ public class SslContextConfigurator {
      * <p>
      * No default value is set.
      * <p>
-     * The name of the configuration property is <tt>{@value}</tt>.
+     * The name of the configuration property is <code>{@value}</code>.
      */
     public static final String KEY_STORE_FILE = "javax.net.ssl.keyStore";
     /**
@@ -107,7 +107,7 @@ public class SslContextConfigurator {
      * <p>
      * No default value is set.
      * <p>
-     * The name of the configuration property is <tt>{@value}</tt>.
+     * The name of the configuration property is <code>{@value}</code>.
      */
     public static final String TRUST_STORE_PASSWORD = "javax.net.ssl.trustStorePassword";
     /**
@@ -117,7 +117,7 @@ public class SslContextConfigurator {
      * <p>
      * No default value is set.
      * <p>
-     * The name of the configuration property is <tt>{@value}</tt>.
+     * The name of the configuration property is <code>{@value}</code>.
      */
     public static final String KEY_STORE_PASSWORD = "javax.net.ssl.keyStorePassword";
     /**
@@ -127,7 +127,7 @@ public class SslContextConfigurator {
      * <p>
      * No default value is set.
      * <p>
-     * The name of the configuration property is <tt>{@value}</tt>.
+     * The name of the configuration property is <code>{@value}</code>.
      */
     public static final String TRUST_STORE_TYPE = "javax.net.ssl.trustStoreType";
     /**
@@ -137,7 +137,7 @@ public class SslContextConfigurator {
      * <p>
      * No default value is set.
      * <p>
-     * The name of the configuration property is <tt>{@value}</tt>.
+     * The name of the configuration property is <code>{@value}</code>.
      */
     public static final String KEY_STORE_TYPE = "javax.net.ssl.keyStoreType";
     /**
@@ -147,7 +147,7 @@ public class SslContextConfigurator {
      * <p>
      * No default value is set.
      * <p>
-     * The name of the configuration property is <tt>{@value}</tt>.
+     * The name of the configuration property is <code>{@value}</code>.
      */
     public static final String KEY_FACTORY_MANAGER_ALGORITHM = "ssl.KeyManagerFactory.algorithm";
     /**
@@ -157,7 +157,7 @@ public class SslContextConfigurator {
      * <p>
      * No default value is set.
      * <p>
-     * The name of the configuration property is <tt>{@value}</tt>.
+     * The name of the configuration property is <code>{@value}</code>.
      */
     public static final String TRUST_FACTORY_MANAGER_ALGORITHM = "ssl.TrustManagerFactory.algorithm";
 

diff --git a/client/src/main/java/org/glassfish/tyrus/client/SslEngineConfigurator.java b/client/src/main/java/org/glassfish/tyrus/client/SslEngineConfigurator.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2008, 2017 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2008, 2021 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0, which is available at
@@ -239,8 +239,8 @@ public SSLEngine configure(final SSLEngine sslEngine) {
     /**
      * Will {@link SSLEngine} be configured to work in client mode.
      *
-     * @return <tt>true</tt>, if {@link SSLEngine} will be configured to work
-     * in <tt>client</tt> mode, or <tt>false</tt> for <tt>server</tt> mode.
+     * @return <code>true</code>, if {@link SSLEngine} will be configured to work
+     * in <code>client</code> mode, or <code>false</code> for <code>server</code> mode.
      */
     public boolean isClientMode() {
         return clientMode;
@@ -249,8 +249,8 @@ public boolean isClientMode() {
     /**
      * Set {@link SSLEngine} to be configured to work in client mode.
      *
-     * @param clientMode <tt>true</tt>, if {@link SSLEngine} will be configured
-     *                   to work in <tt>client</tt> mode, or <tt>false</tt> for <tt>server</tt>
+     * @param clientMode <code>true</code>, if {@link SSLEngine} will be configured
+     *                   to work in <code>client</code> mode, or <code>false</code> for <code>server</code>
      *                   mode.
      * @return updated {@link SslEngineConfigurator}.
      */

diff --git a/client/src/main/java/org/glassfish/tyrus/client/ThreadPoolConfig.java b/client/src/main/java/org/glassfish/tyrus/client/ThreadPoolConfig.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2014, 2017 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2014, 2021 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0, which is available at
@@ -23,10 +23,10 @@
 /**
  * Client thread pool configuration, which might be used to customize client thread pool.
  * <p>
- * One can get a default <tt>ThreadPoolConfig</tt> using {@link ThreadPoolConfig#defaultConfig()}
+ * One can get a default <code>ThreadPoolConfig</code> using {@link ThreadPoolConfig#defaultConfig()}
  * and customize it according to the application specific requirements.
  * <p>
- * A <tt>ThreadPoolConfig</tt> object might be customized in a "Builder"-like fashion:
+ * A <code>ThreadPoolConfig</code> object might be customized in a "Builder"-like fashion:
  * <pre>
  *      ThreadPoolConfig.defaultConfig()
  *               .setPoolName("App1Pool")
@@ -53,7 +53,7 @@ public final class ThreadPoolConfig {
             null, Thread.NORM_PRIORITY, true, null);
 
     /**
-     * Create new client thread pool configuration instance. The returned <tt>ThreadPoolConfig</tt> instance will be
+     * Create new client thread pool configuration instance. The returned <code>ThreadPoolConfig</code> instance will be
      * pre-configured with a default values.
      *
      * @return client thread pool configuration instance.
@@ -295,7 +295,7 @@ public int getQueueLimit() {
      * <p>
      * Value less than 0 means unlimited queue. The default is -1.
      *
-     * @param queueLimit the thread pool queue limit. The <tt>queueLimit</tt> value less than 0 means unlimited queue.
+     * @param queueLimit the thread pool queue limit. The <code>queueLimit</code> value less than 0 means unlimited queue.
      * @return the {@link ThreadPoolConfig} with the new queue limit.
      */
     public ThreadPoolConfig setQueueLimit(int queueLimit) {

diff --git a/...lient/src/main/java/org/glassfish/tyrus/container/grizzly/client/GrizzlyClientFilter.java b/...lient/src/main/java/org/glassfish/tyrus/container/grizzly/client/GrizzlyClientFilter.java
@@ -59,7 +59,7 @@
 /**
  * WebSocket {@link Filter} implementation, which supposed to be placed into a {@link FilterChain} right after HTTP
  * Filter: {@link HttpServerFilter}, {@link HttpClientFilter}; depending whether it's server or client side. The
- * <tt>WebSocketFilter</tt> handles websocket connection, handshake phases and, when receives a websocket frame -
+ * <code>WebSocketFilter</code> handles websocket connection, handshake phases and, when receives a websocket frame -
  * redirects it to appropriate connection ({@link org.glassfish.tyrus.core.TyrusEndpointWrapper}, {@link
  * org.glassfish.tyrus.core.TyrusWebSocket}) for processing.
  *

diff --git a/...erver/src/main/java/org/glassfish/tyrus/container/grizzly/server/GrizzlyServerFilter.java b/...erver/src/main/java/org/glassfish/tyrus/container/grizzly/server/GrizzlyServerFilter.java
@@ -66,7 +66,7 @@
 /**
  * WebSocket {@link Filter} implementation, which supposed to be placed into a {@link FilterChain} right after HTTP
  * Filter: {@link HttpServerFilter}, {@link HttpClientFilter}; depending whether it's server or client side. The
- * <tt>WebSocketFilter</tt> handles websocket connection, handshake phases and, when receives a websocket frame -
+ * <code>WebSocketFilter</code> handles websocket connection, handshake phases and, when receives a websocket frame -
  * redirects it to appropriate connection ({@link org.glassfish.tyrus.core.TyrusEndpointWrapper},
  * {@link org.glassfish.tyrus.core.TyrusWebSocket}) for processing.
  *

diff --git a/...client/src/main/java/org/glassfish/tyrus/container/jdk/client/SslContextConfigurator.java b/...client/src/main/java/org/glassfish/tyrus/container/jdk/client/SslContextConfigurator.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2007, 2017 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2007, 2021 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0, which is available at
@@ -68,7 +68,7 @@ public class SslContextConfigurator {
      * <p>
      * No default value is set.
      * <p>
-     * The name of the configuration property is <tt>{@value}</tt>.
+     * The name of the configuration property is <code>{@value}</code>.
      */
     public static final String TRUST_STORE_PROVIDER = "javax.net.ssl.trustStoreProvider";
     /**
@@ -78,7 +78,7 @@ public class SslContextConfigurator {
      * <p>
      * No default value is set.
      * <p>
-     * The name of the configuration property is <tt>{@value}</tt>.
+     * The name of the configuration property is <code>{@value}</code>.
      */
     public static final String KEY_STORE_PROVIDER = "javax.net.ssl.keyStoreProvider";
     /**
@@ -88,7 +88,7 @@ public class SslContextConfigurator {
      * <p>
      * No default value is set.
      * <p>
-     * The name of the configuration property is <tt>{@value}</tt>.
+     * The name of the configuration property is <code>{@value}</code>.
      */
     public static final String TRUST_STORE_FILE = "javax.net.ssl.trustStore";
     /**
@@ -98,7 +98,7 @@ public class SslContextConfigurator {
      * <p>
      * No default value is set.
      * <p>
-     * The name of the configuration property is <tt>{@value}</tt>.
+     * The name of the configuration property is <code>{@value}</code>.
      */
     public static final String KEY_STORE_FILE = "javax.net.ssl.keyStore";
     /**
@@ -108,7 +108,7 @@ public class SslContextConfigurator {
      * <p>
      * No default value is set.
      * <p>
-     * The name of the configuration property is <tt>{@value}</tt>.
+     * The name of the configuration property is <code>{@value}</code>.
      */
     public static final String TRUST_STORE_PASSWORD = "javax.net.ssl.trustStorePassword";
     /**
@@ -118,7 +118,7 @@ public class SslContextConfigurator {
      * <p>
      * No default value is set.
      * <p>
-     * The name of the configuration property is <tt>{@value}</tt>.
+     * The name of the configuration property is <code>{@value}</code>.
      */
     public static final String KEY_STORE_PASSWORD = "javax.net.ssl.keyStorePassword";
     /**
@@ -128,7 +128,7 @@ public class SslContextConfigurator {
      * <p>
      * No default value is set.
      * <p>
-     * The name of the configuration property is <tt>{@value}</tt>.
+     * The name of the configuration property is <code>{@value}</code>.
      */
     public static final String TRUST_STORE_TYPE = "javax.net.ssl.trustStoreType";
     /**
@@ -138,7 +138,7 @@ public class SslContextConfigurator {
      * <p>
      * No default value is set.
      * <p>
-     * The name of the configuration property is <tt>{@value}</tt>.
+     * The name of the configuration property is <code>{@value}</code>.
      */
     public static final String KEY_STORE_TYPE = "javax.net.ssl.keyStoreType";
     /**
@@ -148,7 +148,7 @@ public class SslContextConfigurator {
      * <p>
      * No default value is set.
      * <p>
-     * The name of the configuration property is <tt>{@value}</tt>.
+     * The name of the configuration property is <code>{@value}</code>.
      */
     public static final String KEY_FACTORY_MANAGER_ALGORITHM = "ssl.KeyManagerFactory.algorithm";
     /**
@@ -158,7 +158,7 @@ public class SslContextConfigurator {
      * <p>
      * No default value is set.
      * <p>
-     * The name of the configuration property is <tt>{@value}</tt>.
+     * The name of the configuration property is <code>{@value}</code>.
      */
     public static final String TRUST_FACTORY_MANAGER_ALGORITHM = "ssl.TrustManagerFactory.algorithm";
 

diff --git a/...-client/src/main/java/org/glassfish/tyrus/container/jdk/client/SslEngineConfigurator.java b/...-client/src/main/java/org/glassfish/tyrus/container/jdk/client/SslEngineConfigurator.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2008, 2017 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2008, 2021 Oracle and/or its affiliates. All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0, which is available at
@@ -220,8 +220,8 @@ public SSLEngine configure(final SSLEngine sslEngine) {
     /**
      * Will {@link SSLEngine} be configured to work in client mode.
      *
-     * @return <tt>true</tt>, if {@link SSLEngine} will be configured to work
-     * in <tt>client</tt> mode, or <tt>false</tt> for <tt>server</tt> mode.
+     * @return <code>true</code>, if {@link SSLEngine} will be configured to work
+     * in <code>client</code> mode, or <code>false</code> for <code>server</code> mode.
      */
     public boolean isClientMode() {
         return clientMode;
@@ -230,8 +230,8 @@ public boolean isClientMode() {
     /**
      * Set {@link SSLEngine} to be configured to work in client mode.
      *
-     * @param clientMode <tt>true</tt>, if {@link SSLEngine} will be configured
-     *                   to work in <tt>client</tt> mode, or <tt>false</tt> for <tt>server</tt>
+     * @param clientMode <code>true</code>, if {@link SSLEngine} will be configured
+     *                   to work in <code>client</code> mode, or <code>false</code> for <code>server</code>
      *                   mode.
      * @return updated configurator instance.
      */