This is an automated email from the ASF dual-hosted git repository.
markt pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tomcat.git
The following commit(s) were added to refs/heads/main by this push:
new 55c7141c44 Javadoc improvements
55c7141c44 is described below
commit 55c7141c44be9e2aaf95a53c00f9d5e54521c393
Author: Mark Thomas <[email protected]>
AuthorDate: Thu Aug 14 15:36:58 2025 +0100
Javadoc improvements
Methods with Javadoc that override/implement methods without identified
by Cursor. Actual Javadoc changes not AI generated.
---
.../webresources/AbstractArchiveResourceSet.java | 8 ++++++++
.../catalina/webresources/JarWarResourceSet.java | 2 +-
java/org/apache/tomcat/util/modeler/FeatureInfo.java | 20 ++++++++++++++++----
.../apache/tomcat/util/modeler/NotificationInfo.java | 12 +-----------
.../apache/tomcat/websocket/BackgroundProcess.java | 5 +++++
.../tomcat/websocket/WsWebSocketContainer.java | 4 +++-
.../tomcat/websocket/server/WsWriteTimeout.java | 4 +++-
7 files changed, 37 insertions(+), 18 deletions(-)
diff --git
a/java/org/apache/catalina/webresources/AbstractArchiveResourceSet.java
b/java/org/apache/catalina/webresources/AbstractArchiveResourceSet.java
index ff0ca34b33..c242359d4d 100644
--- a/java/org/apache/catalina/webresources/AbstractArchiveResourceSet.java
+++ b/java/org/apache/catalina/webresources/AbstractArchiveResourceSet.java
@@ -313,6 +313,14 @@ public abstract class AbstractArchiveResourceSet extends
AbstractResourceSet {
return false;
}
+ /**
+ * Create a JarFile for accessing the elements of the resource set.
Depending on the
+ * {@link WebResourceRoot#getArchiveIndexStrategy()}, it may also index
the elements for faster lookups.
+ *
+ * @return A JarFile to use to access the elements of the resource set
+ *
+ * @throws IOException If an error occurs creating the JarFile
+ */
protected JarFile openJarFile() throws IOException {
synchronized (archiveLock) {
if (archive == null) {
diff --git a/java/org/apache/catalina/webresources/JarWarResourceSet.java
b/java/org/apache/catalina/webresources/JarWarResourceSet.java
index f557c6e714..f1333e5da8 100644
--- a/java/org/apache/catalina/webresources/JarWarResourceSet.java
+++ b/java/org/apache/catalina/webresources/JarWarResourceSet.java
@@ -160,7 +160,7 @@ public class JarWarResourceSet extends
AbstractArchiveResourceSet {
/**
* {@inheritDoc}
* <p>
- * JarWar needs to generate jarContents for the inner JAR, not the outer
WAR.
+ * JarWar needs to generate the index (jarContents) for the inner JAR, not
the outer WAR.
*/
@Override
protected JarFile openJarFile() throws IOException {
diff --git a/java/org/apache/tomcat/util/modeler/FeatureInfo.java
b/java/org/apache/tomcat/util/modeler/FeatureInfo.java
index 8baf549192..a2776a0d54 100644
--- a/java/org/apache/tomcat/util/modeler/FeatureInfo.java
+++ b/java/org/apache/tomcat/util/modeler/FeatureInfo.java
@@ -16,13 +16,11 @@
*/
package org.apache.tomcat.util.modeler;
-
import java.io.Serial;
import java.io.Serializable;
import javax.management.MBeanFeatureInfo;
-
/**
* <p>
* Convenience base class for <code>AttributeInfo</code> and
<code>OperationInfo</code> classes that will be used to
@@ -52,6 +50,11 @@ public class FeatureInfo implements Serializable {
return this.description;
}
+ /**
+ * Set the human-readable description of this feature.
+ *
+ * @param description The new description
+ */
public void setDescription(String description) {
this.description = description;
}
@@ -64,10 +67,16 @@ public class FeatureInfo implements Serializable {
return this.name;
}
+ /**
+ * Set the name of this feature, which must be unique among features in
the same collection.
+ *
+ * @param name The new name
+ */
public void setName(String name) {
this.name = name;
}
+
/**
* @return the fully qualified Java class name of this element.
*/
@@ -75,9 +84,12 @@ public class FeatureInfo implements Serializable {
return this.type;
}
+ /**
+ * Set the fully qualified Java class name of this element.
+ *
+ * @param type The new fully qualified Java class name
+ */
public void setType(String type) {
this.type = type;
}
-
-
}
diff --git a/java/org/apache/tomcat/util/modeler/NotificationInfo.java
b/java/org/apache/tomcat/util/modeler/NotificationInfo.java
index f1f24eccd1..f131cef198 100644
--- a/java/org/apache/tomcat/util/modeler/NotificationInfo.java
+++ b/java/org/apache/tomcat/util/modeler/NotificationInfo.java
@@ -46,14 +46,9 @@ public class NotificationInfo extends FeatureInfo {
protected String[] notifTypes = new String[0];
protected final ReadWriteLock notifTypesLock = new
ReentrantReadWriteLock();
- // ------------------------------------------------------------- Properties
+ // ------------------------------------------------------------- Properties
- /**
- * Override the <code>description</code> property setter.
- *
- * @param description The new description
- */
@Override
public void setDescription(String description) {
super.setDescription(description);
@@ -61,11 +56,6 @@ public class NotificationInfo extends FeatureInfo {
}
- /**
- * Override the <code>name</code> property setter.
- *
- * @param name The new name
- */
@Override
public void setName(String name) {
super.setName(name);
diff --git a/java/org/apache/tomcat/websocket/BackgroundProcess.java
b/java/org/apache/tomcat/websocket/BackgroundProcess.java
index 510df5748b..c0e2a6621d 100644
--- a/java/org/apache/tomcat/websocket/BackgroundProcess.java
+++ b/java/org/apache/tomcat/websocket/BackgroundProcess.java
@@ -22,5 +22,10 @@ public interface BackgroundProcess {
void setProcessPeriod(int period);
+ /**
+ * Obtain the currently configured period, in seconds, between invocations
of {@link #backgroundProcess()}.
+ *
+ * @return The period, in seconds, between invocations of {@link
BackgroundProcess#backgroundProcess()}
+ */
int getProcessPeriod();
}
diff --git a/java/org/apache/tomcat/websocket/WsWebSocketContainer.java
b/java/org/apache/tomcat/websocket/WsWebSocketContainer.java
index 840538da00..b9896e3ff4 100644
--- a/java/org/apache/tomcat/websocket/WsWebSocketContainer.java
+++ b/java/org/apache/tomcat/websocket/WsWebSocketContainer.java
@@ -1054,7 +1054,9 @@ public class WsWebSocketContainer implements
WebSocketContainer, BackgroundProce
/**
- * {@inheritDoc} The default value is 10 which means session expirations
are processed every 10 seconds.
+ * {@inheritDoc}
+ * <p>
+ * The default value is 10 which means session expirations are processed
every 10 seconds.
*/
@Override
public int getProcessPeriod() {
diff --git a/java/org/apache/tomcat/websocket/server/WsWriteTimeout.java
b/java/org/apache/tomcat/websocket/server/WsWriteTimeout.java
index be5f23b6f8..24d59535c0 100644
--- a/java/org/apache/tomcat/websocket/server/WsWriteTimeout.java
+++ b/java/org/apache/tomcat/websocket/server/WsWriteTimeout.java
@@ -72,7 +72,9 @@ public class WsWriteTimeout implements BackgroundProcess {
/**
- * {@inheritDoc} The default value is 1 which means asynchronous write
timeouts are processed every 1 second.
+ * {@inheritDoc}
+ * <p>
+ * The default value is 1 which means asynchronous write timeouts are
processed every 1 second.
*/
@Override
public int getProcessPeriod() {
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
