This is an automated email from the ASF dual-hosted git repository.
elecharny pushed a commit to branch 2.2.X
in repository https://gitbox.apache.org/repos/asf/mina.git
The following commit(s) were added to refs/heads/2.2.X by this push:
new b65685c2b fixed some javadoc issues"
b65685c2b is described below
commit b65685c2b321bf4dc7f8c479e842835b29bac2e0
Author: emmanuel lecharny <[email protected]>
AuthorDate: Wed May 31 23:54:57 2023 +0200
fixed some javadoc issues"
---
.../executor/PriorityThreadPoolExecutor.java | 94 +++++++++++++---------
.../mina/filter/keepalive/KeepAliveFilter.java | 2 +-
.../java/org/apache/mina/filter/ssl/SslFilter.java | 4 +-
3 files changed, 58 insertions(+), 42 deletions(-)
diff --git
a/mina-core/src/main/java/org/apache/mina/filter/executor/PriorityThreadPoolExecutor.java
b/mina-core/src/main/java/org/apache/mina/filter/executor/PriorityThreadPoolExecutor.java
index 5a995f961..8185f4099 100644
---
a/mina-core/src/main/java/org/apache/mina/filter/executor/PriorityThreadPoolExecutor.java
+++
b/mina-core/src/main/java/org/apache/mina/filter/executor/PriorityThreadPoolExecutor.java
@@ -104,9 +104,14 @@ public class PriorityThreadPoolExecutor extends
ThreadPoolExecutor {
private final Comparator<IoSession> comparator;
/**
- * Creates a default ThreadPool, with default values : - minimum pool size
is 0
- * - maximum pool size is 16 - keepAlive set to 30 seconds - A default
- * ThreadFactory - All events are accepted
+ * Creates a default ThreadPool, with default values :
+ * <ul>
+ * <li>minimum pool size is 0</li>
+ * <li>maximum pool size is 16</li>
+ * <li>keepAlive set to 30 seconds</li>
+ * <li>A default ThreadFactory</li>
+ * <li>All events are accepted</li>
+ * </ul>
*/
public PriorityThreadPoolExecutor() {
this(DEFAULT_INITIAL_THREAD_POOL_SIZE, DEFAULT_MAX_THREAD_POOL,
DEFAULT_KEEP_ALIVE, TimeUnit.SECONDS,
@@ -114,9 +119,14 @@ public class PriorityThreadPoolExecutor extends
ThreadPoolExecutor {
}
/**
- * Creates a default ThreadPool, with default values : - minimum pool size
is 0
- * - maximum pool size is 16 - keepAlive set to 30 seconds - A default
- * ThreadFactory - All events are accepted
+ * Creates a default ThreadPool, with default values :
+ * <ul>
+ * <li>minimum pool size is 0</li>
+ * <li>maximum pool size is 16</li>
+ * <li>keepAlive set to 30 seconds</li>
+ * <li>A default ThreadFactory</li>
+ * <li>All events are accepted</li>
+ * </ul>
*
* @param comparator The comparator used to prioritize the queue
*/
@@ -141,12 +151,16 @@ public class PriorityThreadPoolExecutor extends
ThreadPoolExecutor {
}
/**
- * Creates a default ThreadPool, with default values : - minimum pool size
is 0
- * - keepAlive set to 30 seconds - A default ThreadFactory - All events are
- * accepted
+ * Creates a default ThreadPool, with default values :
+ * <ul>
+ * <li>minimum pool size is 0</li>
+ * <li>keepAlive set to 30 seconds</li>
+ * <li>A default ThreadFactory</li>
+ * <li>All events are accepted</li>
+ * </ul>
*
- * @param maximumPoolSize
- * The maximum pool size
+ * @param maximumPoolSize The maximum pool size
+ * @param comparator The The comparator used to prioritize the queue
*/
public PriorityThreadPoolExecutor(int maximumPoolSize,
Comparator<IoSession> comparator) {
this(DEFAULT_INITIAL_THREAD_POOL_SIZE, maximumPoolSize,
DEFAULT_KEEP_ALIVE, TimeUnit.SECONDS,
@@ -154,13 +168,15 @@ public class PriorityThreadPoolExecutor extends
ThreadPoolExecutor {
}
/**
- * Creates a default ThreadPool, with default values : - keepAlive set to
30
- * seconds - A default ThreadFactory - All events are accepted
+ * Creates a default ThreadPool, with default values :
+ * <ul>
+ * <li>keepAlive set to 30 seconds</li>
+ * <li>A default ThreadFactory</li>
+ * <li>All events are accepted</li>
+ * </ul>
*
- * @param corePoolSize
- * The initial pool sizePoolSize
- * @param maximumPoolSize
- * The maximum pool size
+ * @param corePoolSize The initial pool sizePoolSize
+ * @param maximumPoolSize The maximum pool size
*/
public PriorityThreadPoolExecutor(int corePoolSize, int maximumPoolSize) {
this(corePoolSize, maximumPoolSize, DEFAULT_KEEP_ALIVE,
TimeUnit.SECONDS, Executors.defaultThreadFactory(),
@@ -168,35 +184,32 @@ public class PriorityThreadPoolExecutor extends
ThreadPoolExecutor {
}
/**
- * Creates a default ThreadPool, with default values : - A default
ThreadFactory
- * - All events are accepted
+ * Creates a default ThreadPool, with default values :
+ * <ul>
+ * <li>A default ThreadFactory</li>
+ * <li>All events are accepted</li>
+ * </ul>
*
- * @param corePoolSize
- * The initial pool sizePoolSize
- * @param maximumPoolSize
- * The maximum pool size
- * @param keepAliveTime
- * Default duration for a thread
- * @param unit
- * Time unit used for the keepAlive value
+ * @param corePoolSize The initial pool sizePoolSize
+ * @param maximumPoolSize The maximum pool size
+ * @param keepAliveTime Default duration for a thread
+ * @param unit Time unit used for the keepAlive value
*/
public PriorityThreadPoolExecutor(int corePoolSize, int maximumPoolSize,
long keepAliveTime, TimeUnit unit) {
this(corePoolSize, maximumPoolSize, keepAliveTime, unit,
Executors.defaultThreadFactory(), null, null);
}
/**
- * Creates a default ThreadPool, with default values : - A default
ThreadFactory
+ * Creates a default ThreadPool, with default values :
+ * <ul>
+ * <li>A default ThreadFactory</li>
+ * </ul>
*
- * @param corePoolSize
- * The initial pool sizePoolSize
- * @param maximumPoolSize
- * The maximum pool size
- * @param keepAliveTime
- * Default duration for a thread
- * @param unit
- * Time unit used for the keepAlive value
- * @param eventQueueHandler
- * The queue used to store events
+ * @param corePoolSize The initial pool sizePoolSize
+ * @param maximumPoolSize The maximum pool size
+ * @param keepAliveTime Default duration for a thread
+ * @param unit Time unit used for the keepAlive value
+ * @param eventQueueHandler The queue used to store events
*/
public PriorityThreadPoolExecutor(int corePoolSize, int maximumPoolSize,
long keepAliveTime, TimeUnit unit,
IoEventQueueHandler eventQueueHandler) {
@@ -205,7 +218,10 @@ public class PriorityThreadPoolExecutor extends
ThreadPoolExecutor {
}
/**
- * Creates a default ThreadPool, with default values : - A default
ThreadFactory
+ * Creates a default ThreadPool, with default values :
+ * <ul>
+ * <li>A default ThreadFactory</li>
+ * </ul>
*
* @param corePoolSize The initial pool sizePoolSize
* @param maximumPoolSize The maximum pool size
diff --git
a/mina-core/src/main/java/org/apache/mina/filter/keepalive/KeepAliveFilter.java
b/mina-core/src/main/java/org/apache/mina/filter/keepalive/KeepAliveFilter.java
index 6e87f6257..d264ca7ff 100644
---
a/mina-core/src/main/java/org/apache/mina/filter/keepalive/KeepAliveFilter.java
+++
b/mina-core/src/main/java/org/apache/mina/filter/keepalive/KeepAliveFilter.java
@@ -55,7 +55,7 @@ import org.apache.mina.core.write.WriteRequest;
* message is a keep-alive message or not and creates a new keep-alive
* message:
*
- * <table border="1" summary="Message">
+ * <table border="1">
* <tr>
* <th>Name</th><th>Description</th><th>Implementation</th>
* </tr>
diff --git a/mina-core/src/main/java/org/apache/mina/filter/ssl/SslFilter.java
b/mina-core/src/main/java/org/apache/mina/filter/ssl/SslFilter.java
index 052c899b3..e6dc76c6b 100644
--- a/mina-core/src/main/java/org/apache/mina/filter/ssl/SslFilter.java
+++ b/mina-core/src/main/java/org/apache/mina/filter/ssl/SslFilter.java
@@ -174,7 +174,7 @@ public class SslFilter extends IoFilterAdapter {
/**
* @return the endpoint identification algorithm to be used when {@link
SSLEngine}
- * is initialized. <tt>null</tt> means 'use {@link SSLEngine}'s default.'
+ * is initialized. <code>null</code> means 'use {@link SSLEngine}'s
default.'
*/
public String getEndpointIdentificationAlgorithm() {
return identificationAlgorithm;
@@ -184,7 +184,7 @@ public class SslFilter extends IoFilterAdapter {
* Sets the endpoint identification algorithm to be used when {@link
SSLEngine}
* is initialized.
*
- * @param identificationAlgorithm <tt>null</tt> means 'use {@link
SSLEngine}'s default.'
+ * @param identificationAlgorithm <code>null</code> means 'use {@link
SSLEngine}'s default.'
*/
public void setEndpointIdentificationAlgorithm(String
identificationAlgorithm) {
this.identificationAlgorithm = identificationAlgorithm;
