This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-jcs.git


The following commit(s) were added to refs/heads/master by this push:
     new 03c91717 Javadoc
03c91717 is described below

commit 03c917176c2c3632f413335e6f7549c9b541e591
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Thu Dec 14 10:28:54 2023 -0500

    Javadoc
---
 .../apache/commons/jcs3/auxiliary/disk/indexed/IndexedDiskCache.java  | 2 +-
 .../java/org/apache/commons/jcs3/engine/CacheWatchRepairable.java     | 2 +-
 .../org/apache/commons/jcs3/engine/control/group/GroupAttrName.java   | 2 +-
 .../java/org/apache/commons/jcs3/engine/control/group/GroupId.java    | 2 +-
 .../main/java/org/apache/commons/jcs3/engine/stats/StatElement.java   | 2 +-
 .../org/apache/commons/jcs3/utils/discovery/UDPDiscoveryService.java  | 2 +-
 .../org/apache/commons/jcs3/utils/threadpool/ThreadPoolManager.java   | 4 ++--
 .../org/apache/commons/jcs3/auxiliary/MockAuxiliaryCacheFactory.java  | 2 +-
 .../jcs3/auxiliary/disk/block/BlockDiskCacheSteadyLoadTest.java       | 2 +-
 .../lateral/socket/tcp/LateralTCPDiscoveryListenerUnitTest.java       | 4 ++--
 .../apache/commons/jcs3/auxiliary/remote/RemoteCacheClientTester.java | 4 ++--
 .../java/org/apache/commons/jcs/access/PartitionedCacheAccess.java    | 2 +-
 12 files changed, 15 insertions(+), 15 deletions(-)

diff --git 
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/indexed/IndexedDiskCache.java
 
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/indexed/IndexedDiskCache.java
index 8cfa25b4..39cc068a 100644
--- 
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/indexed/IndexedDiskCache.java
+++ 
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/indexed/IndexedDiskCache.java
@@ -276,7 +276,7 @@ public class IndexedDiskCache<K, V> extends 
AbstractDiskCache<K, V>
     /** How many items were there on startup. */
     private int startupSize;
 
-    /** the number of bytes free on disk. */
+    /** The number of bytes free on disk. */
     private final AtomicLong bytesFree = new AtomicLong();
 
     /** mode we are working on (size or count limited **/
diff --git 
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/CacheWatchRepairable.java
 
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/CacheWatchRepairable.java
index 093a6644..121963b4 100644
--- 
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/CacheWatchRepairable.java
+++ 
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/CacheWatchRepairable.java
@@ -42,7 +42,7 @@ public class CacheWatchRepairable
     /** The logger */
     private static final Log log = LogManager.getLog( 
CacheWatchRepairable.class );
 
-    /** the underlying ICacheObserver. */
+    /** The underlying ICacheObserver. */
     private ICacheObserver cacheWatch;
 
     /** Map of cache regions. */
diff --git 
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/control/group/GroupAttrName.java
 
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/control/group/GroupAttrName.java
index 4e12b9a3..70903094 100644
--- 
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/control/group/GroupAttrName.java
+++ 
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/control/group/GroupAttrName.java
@@ -34,7 +34,7 @@ public class GroupAttrName<T>
     /** Description of the Field */
     public final GroupId groupId;
 
-    /** the name of the attribute */
+    /** The name of the attribute */
     public final T attrName;
 
     /**
diff --git 
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/control/group/GroupId.java
 
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/control/group/GroupId.java
index 1b4f4bd6..bc0ed763 100644
--- 
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/control/group/GroupId.java
+++ 
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/control/group/GroupId.java
@@ -35,7 +35,7 @@ public class GroupId
     /** Description of the Field */
     public final String groupName;
 
-    /** the name of the region. */
+    /** The name of the region. */
     public final String cacheName;
 
     /**
diff --git 
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/stats/StatElement.java
 
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/stats/StatElement.java
index b3f8f861..e5eac7ac 100644
--- 
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/stats/StatElement.java
+++ 
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/stats/StatElement.java
@@ -33,7 +33,7 @@ public class StatElement<V>
     /** name of the stat */
     private String name;
 
-    /** the data */
+    /** The data */
     private V data;
 
     /**
diff --git 
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/utils/discovery/UDPDiscoveryService.java
 
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/utils/discovery/UDPDiscoveryService.java
index 83527a12..48b4ea57 100644
--- 
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/utils/discovery/UDPDiscoveryService.java
+++ 
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/utils/discovery/UDPDiscoveryService.java
@@ -63,7 +63,7 @@ public class UDPDiscoveryService
     /** thread that listens for messages */
     private Thread udpReceiverThread;
 
-    /** the runnable that the receiver thread runs */
+    /** The runnable that the receiver thread runs */
     private UDPDiscoveryReceiver receiver;
 
     /** attributes */
diff --git 
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/utils/threadpool/ThreadPoolManager.java
 
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/utils/threadpool/ThreadPoolManager.java
index 8d7303ef..358972a6 100644
--- 
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/utils/threadpool/ThreadPoolManager.java
+++ 
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/utils/threadpool/ThreadPoolManager.java
@@ -69,13 +69,13 @@ public class ThreadPoolManager
     /** The logger */
     private static final Log log = LogManager.getLog( ThreadPoolManager.class 
);
 
-    /** the root property name */
+    /** The root property name */
     private static final String PROP_NAME_ROOT = "thread_pool";
 
     /** default property file name */
     private static final String DEFAULT_PROP_NAME_ROOT = "thread_pool.default";
 
-    /** the scheduler root property name */
+    /** The scheduler root property name */
     private static final String PROP_NAME_SCHEDULER_ROOT = "scheduler_pool";
 
     /** default scheduler property file name */
diff --git 
a/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/auxiliary/MockAuxiliaryCacheFactory.java
 
b/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/auxiliary/MockAuxiliaryCacheFactory.java
index e24c02ea..701cea06 100644
--- 
a/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/auxiliary/MockAuxiliaryCacheFactory.java
+++ 
b/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/auxiliary/MockAuxiliaryCacheFactory.java
@@ -27,7 +27,7 @@ import 
org.apache.commons.jcs3.engine.logging.behavior.ICacheEventLogger;
 public class MockAuxiliaryCacheFactory
     extends AbstractAuxiliaryCacheFactory
 {
-    /** the name of the aux */
+    /** The name of the aux */
     public String name = "MockAuxiliaryCacheFactory";
 
     /**
diff --git 
a/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/auxiliary/disk/block/BlockDiskCacheSteadyLoadTest.java
 
b/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/auxiliary/disk/block/BlockDiskCacheSteadyLoadTest.java
index 6193eed5..8a8e0d44 100644
--- 
a/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/auxiliary/disk/block/BlockDiskCacheSteadyLoadTest.java
+++ 
b/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/auxiliary/disk/block/BlockDiskCacheSteadyLoadTest.java
@@ -36,7 +36,7 @@ public class BlockDiskCacheSteadyLoadTest
     /** String for separating log entries. */
     private static final String LOG_DIVIDER = "---------------------------";
 
-    /** the runtime. */
+    /** The runtime. */
     private static final Runtime rt = Runtime.getRuntime();
 
     /** The decimal format to use int he logs. */
diff --git 
a/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/LateralTCPDiscoveryListenerUnitTest.java
 
b/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/LateralTCPDiscoveryListenerUnitTest.java
index 64c3a3a5..b888f6b3 100644
--- 
a/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/LateralTCPDiscoveryListenerUnitTest.java
+++ 
b/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/LateralTCPDiscoveryListenerUnitTest.java
@@ -41,10 +41,10 @@ import org.junit.Test;
 /** Test for the listener that observers UDP discovery events. */
 public class LateralTCPDiscoveryListenerUnitTest
 {
-    /** the listener */
+    /** The listener */
     private LateralTCPDiscoveryListener listener;
 
-    /** the cache factory */
+    /** The cache factory */
     private LateralTCPCacheFactory factory;
 
     /** The cache manager. */
diff --git 
a/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/auxiliary/remote/RemoteCacheClientTester.java
 
b/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/auxiliary/remote/RemoteCacheClientTester.java
index bab7288b..5c75a28a 100644
--- 
a/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/auxiliary/remote/RemoteCacheClientTester.java
+++ 
b/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/auxiliary/remote/RemoteCacheClientTester.java
@@ -96,10 +96,10 @@ public class RemoteCacheClientTester
         System.out.println( s );
     }
 
-    /** the observer */
+    /** The observer */
     protected ICacheObserver watch;
 
-    /** the service */
+    /** The service */
     protected ICacheService<String, String> cache;
 
     /** The registry host name. */
diff --git 
a/commons-jcs3-sandbox/commons-jcs3-partitioned/src/main/java/org/apache/commons/jcs/access/PartitionedCacheAccess.java
 
b/commons-jcs3-sandbox/commons-jcs3-partitioned/src/main/java/org/apache/commons/jcs/access/PartitionedCacheAccess.java
index 14f48909..64fffad4 100644
--- 
a/commons-jcs3-sandbox/commons-jcs3-partitioned/src/main/java/org/apache/commons/jcs/access/PartitionedCacheAccess.java
+++ 
b/commons-jcs3-sandbox/commons-jcs3-partitioned/src/main/java/org/apache/commons/jcs/access/PartitionedCacheAccess.java
@@ -62,7 +62,7 @@ public class PartitionedCacheAccess<K, V>
     extends AbstractPropertyContainer
     implements ICacheAccess<K, V>
 {
-    /** the logger. */
+    /** The logger. */
     private static final Log log = LogManager.getLog( 
PartitionedCacheAccess.class );
 
     /** The number of partitions. */

Reply via email to