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-logging.git
The following commit(s) were added to refs/heads/master by this push:
new b7f50da Normalize setter Javadoc
b7f50da is described below
commit b7f50da2aaf7fab1978e5a52ba1a380fa647cfa0
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Tue Oct 31 07:10:27 2023 -0400
Normalize setter Javadoc
---
src/main/java/org/apache/commons/logging/LogFactory.java | 2 +-
src/main/java/org/apache/commons/logging/LogSource.java | 4 ++--
src/main/java/org/apache/commons/logging/impl/LogFactoryImpl.java | 2 +-
src/main/java/org/apache/commons/logging/impl/SimpleLog.java | 2 +-
src/test/java/org/apache/commons/logging/AltHashtableTestCase.java | 2 +-
src/test/java/org/apache/commons/logging/UserClass.java | 2 +-
.../apache/commons/logging/config/FirstPriorityConfigTestCase.java | 2 +-
.../org/apache/commons/logging/config/PriorityConfigTestCase.java | 2 +-
.../java/org/apache/commons/logging/jdk14/CustomConfigTestCase.java | 2 +-
.../java/org/apache/commons/logging/jdk14/DefaultConfigTestCase.java | 2 +-
src/test/java/org/apache/commons/logging/log4j/StandardTests.java | 2 +-
src/test/java/org/apache/commons/logging/logkit/StandardTestCase.java | 2 +-
src/test/java/org/apache/commons/logging/noop/NoOpLogTestCase.java | 2 +-
.../java/org/apache/commons/logging/pathable/ChildFirstTestCase.java | 2 +-
.../java/org/apache/commons/logging/pathable/GeneralTestCase.java | 2 +-
.../java/org/apache/commons/logging/pathable/ParentFirstTestCase.java | 2 +-
.../java/org/apache/commons/logging/simple/CustomConfigTestCase.java | 4 ++--
.../apache/commons/logging/simple/DateTimeCustomConfigTestCase.java | 4 ++--
.../java/org/apache/commons/logging/simple/DefaultConfigTestCase.java | 4 ++--
.../org/apache/commons/logging/tccl/log/TcclDisabledTestCase.java | 2 +-
.../java/org/apache/commons/logging/tccl/log/TcclEnabledTestCase.java | 2 +-
.../apache/commons/logging/tccl/logfactory/TcclDisabledTestCase.java | 2 +-
.../apache/commons/logging/tccl/logfactory/TcclEnabledTestCase.java | 2 +-
23 files changed, 27 insertions(+), 27 deletions(-)
diff --git a/src/main/java/org/apache/commons/logging/LogFactory.java
b/src/main/java/org/apache/commons/logging/LogFactory.java
index a321d84..b4484ff 100644
--- a/src/main/java/org/apache/commons/logging/LogFactory.java
+++ b/src/main/java/org/apache/commons/logging/LogFactory.java
@@ -1636,7 +1636,7 @@ public abstract class LogFactory {
// ----------------------------------------------------------------------
/**
- * Set the configuration attribute with the specified name. Calling
+ * Sets the configuration attribute with the specified name. Calling
* this with a {@code null} value is equivalent to calling
* {@code removeAttribute(name)}.
*
diff --git a/src/main/java/org/apache/commons/logging/LogSource.java
b/src/main/java/org/apache/commons/logging/LogSource.java
index 1c90d8c..3201331 100644
--- a/src/main/java/org/apache/commons/logging/LogSource.java
+++ b/src/main/java/org/apache/commons/logging/LogSource.java
@@ -200,7 +200,7 @@ public class LogSource {
}
/**
- * Set the log implementation/log implementation factory by class. The
given class must implement {@link Log}, and provide a constructor that takes a
single
+ * Sets the log implementation/log implementation factory by class. The
given class must implement {@link Log}, and provide a constructor that takes a
single
* {@link String} argument (containing the name of the log).
*
* @param logclass class.
@@ -219,7 +219,7 @@ public class LogSource {
}
/**
- * Set the log implementation/log implementation factory by the name of
the class. The given class must implement {@link Log}, and provide a constructor
+ * Sets the log implementation/log implementation factory by the name of
the class. The given class must implement {@link Log}, and provide a constructor
* that takes a single {@link String} argument (containing the name of the
log).
*
* @param className class name.
diff --git a/src/main/java/org/apache/commons/logging/impl/LogFactoryImpl.java
b/src/main/java/org/apache/commons/logging/impl/LogFactoryImpl.java
index df35319..b2794f8 100644
--- a/src/main/java/org/apache/commons/logging/impl/LogFactoryImpl.java
+++ b/src/main/java/org/apache/commons/logging/impl/LogFactoryImpl.java
@@ -1353,7 +1353,7 @@ public class LogFactoryImpl extends LogFactory {
}
/**
- * Set the configuration attribute with the specified name. Calling
+ * Sets the configuration attribute with the specified name. Calling
* this with a {@code null} value is equivalent to calling
* {@code removeAttribute(name)}.
* <p>
diff --git a/src/main/java/org/apache/commons/logging/impl/SimpleLog.java
b/src/main/java/org/apache/commons/logging/impl/SimpleLog.java
index d14807f..bdccf6e 100644
--- a/src/main/java/org/apache/commons/logging/impl/SimpleLog.java
+++ b/src/main/java/org/apache/commons/logging/impl/SimpleLog.java
@@ -595,7 +595,7 @@ public class SimpleLog implements Log, Serializable {
}
/**
- * Set logging level.
+ * Sets logging level.
*
* @param currentLogLevel new logging level
*/
diff --git a/src/test/java/org/apache/commons/logging/AltHashtableTestCase.java
b/src/test/java/org/apache/commons/logging/AltHashtableTestCase.java
index 28b515f..21c40ab 100644
--- a/src/test/java/org/apache/commons/logging/AltHashtableTestCase.java
+++ b/src/test/java/org/apache/commons/logging/AltHashtableTestCase.java
@@ -41,7 +41,7 @@ public class AltHashtableTestCase extends TestCase {
}
/**
- * Set up before each test.
+ * Sets up before each test.
* <p>
* This method ensures that the appropriate system property is defined
* to force the LogFactory class to use the AltHashtable class as its
diff --git a/src/test/java/org/apache/commons/logging/UserClass.java
b/src/test/java/org/apache/commons/logging/UserClass.java
index 60a8138..8401146 100644
--- a/src/test/java/org/apache/commons/logging/UserClass.java
+++ b/src/test/java/org/apache/commons/logging/UserClass.java
@@ -21,7 +21,7 @@ import org.apache.commons.logging.impl.LogFactoryImpl;
public class UserClass {
/**
- * Set the ALLOW_FLAWED_CONTEXT feature on the LogFactoryImpl object
+ * Sets the ALLOW_FLAWED_CONTEXT feature on the LogFactoryImpl object
* associated with this class' classloader.
* <p>
* Don't forget to set the context classloader to whatever it will be
diff --git
a/src/test/java/org/apache/commons/logging/config/FirstPriorityConfigTestCase.java
b/src/test/java/org/apache/commons/logging/config/FirstPriorityConfigTestCase.java
index 250f6e6..dc1c950 100644
---
a/src/test/java/org/apache/commons/logging/config/FirstPriorityConfigTestCase.java
+++
b/src/test/java/org/apache/commons/logging/config/FirstPriorityConfigTestCase.java
@@ -85,7 +85,7 @@ public class FirstPriorityConfigTestCase extends TestCase {
}
/**
- * Set up instance variables required by this test case.
+ * Sets up instance variables required by this test case.
*/
@Override
public void setUp() throws Exception {
diff --git
a/src/test/java/org/apache/commons/logging/config/PriorityConfigTestCase.java
b/src/test/java/org/apache/commons/logging/config/PriorityConfigTestCase.java
index 78774f3..8a7f9ca 100644
---
a/src/test/java/org/apache/commons/logging/config/PriorityConfigTestCase.java
+++
b/src/test/java/org/apache/commons/logging/config/PriorityConfigTestCase.java
@@ -103,7 +103,7 @@ public class PriorityConfigTestCase extends TestCase {
}
/**
- * Set up instance variables required by this test case.
+ * Sets up instance variables required by this test case.
*/
@Override
public void setUp() throws Exception {
diff --git
a/src/test/java/org/apache/commons/logging/jdk14/CustomConfigTestCase.java
b/src/test/java/org/apache/commons/logging/jdk14/CustomConfigTestCase.java
index 7d968ae..f4778bc 100644
--- a/src/test/java/org/apache/commons/logging/jdk14/CustomConfigTestCase.java
+++ b/src/test/java/org/apache/commons/logging/jdk14/CustomConfigTestCase.java
@@ -264,7 +264,7 @@ public class CustomConfigTestCase extends
DefaultConfigTestCase {
/**
- * Set up instance variables required by this test case.
+ * Sets up instance variables required by this test case.
*/
@Override
public void setUp() throws Exception {
diff --git
a/src/test/java/org/apache/commons/logging/jdk14/DefaultConfigTestCase.java
b/src/test/java/org/apache/commons/logging/jdk14/DefaultConfigTestCase.java
index 1645881..15d35e9 100644
--- a/src/test/java/org/apache/commons/logging/jdk14/DefaultConfigTestCase.java
+++ b/src/test/java/org/apache/commons/logging/jdk14/DefaultConfigTestCase.java
@@ -90,7 +90,7 @@ public class DefaultConfigTestCase extends TestCase {
}
/**
- * Set up instance variables required by this test case.
+ * Sets up instance variables required by this test case.
*/
@Override
public void setUp() throws Exception {
diff --git a/src/test/java/org/apache/commons/logging/log4j/StandardTests.java
b/src/test/java/org/apache/commons/logging/log4j/StandardTests.java
index b1700da..1456e0d 100644
--- a/src/test/java/org/apache/commons/logging/log4j/StandardTests.java
+++ b/src/test/java/org/apache/commons/logging/log4j/StandardTests.java
@@ -119,7 +119,7 @@ public abstract class StandardTests extends TestCase {
}
/**
- * Set up instance variables required by this test case.
+ * Sets up instance variables required by this test case.
*/
@Override
public void setUp() throws Exception {
diff --git
a/src/test/java/org/apache/commons/logging/logkit/StandardTestCase.java
b/src/test/java/org/apache/commons/logging/logkit/StandardTestCase.java
index 9abc18c..aab3d10 100644
--- a/src/test/java/org/apache/commons/logging/logkit/StandardTestCase.java
+++ b/src/test/java/org/apache/commons/logging/logkit/StandardTestCase.java
@@ -104,7 +104,7 @@ public class StandardTestCase extends AbstractLogTest {
// ----------------------------------------------------------- Test Methods
/**
- * Set up instance variables required by this test case.
+ * Sets up instance variables required by this test case.
*/
@Override
public void setUp() throws Exception {
diff --git a/src/test/java/org/apache/commons/logging/noop/NoOpLogTestCase.java
b/src/test/java/org/apache/commons/logging/noop/NoOpLogTestCase.java
index 5ec4b04..868d02a 100644
--- a/src/test/java/org/apache/commons/logging/noop/NoOpLogTestCase.java
+++ b/src/test/java/org/apache/commons/logging/noop/NoOpLogTestCase.java
@@ -62,7 +62,7 @@ public class NoOpLogTestCase extends AbstractLogTest
}
/**
- * Set up instance variables required by this test case.
+ * Sets up instance variables required by this test case.
*/
@Override
public void setUp() throws Exception {
diff --git
a/src/test/java/org/apache/commons/logging/pathable/ChildFirstTestCase.java
b/src/test/java/org/apache/commons/logging/pathable/ChildFirstTestCase.java
index 27f8b00..d7b75dc 100644
--- a/src/test/java/org/apache/commons/logging/pathable/ChildFirstTestCase.java
+++ b/src/test/java/org/apache/commons/logging/pathable/ChildFirstTestCase.java
@@ -43,7 +43,7 @@ import org.apache.commons.logging.PathableTestSuite;
public class ChildFirstTestCase extends TestCase {
/**
- * Set up a custom classloader hierarchy for this test case.
+ * Sets up a custom classloader hierarchy for this test case.
* The hierarchy is:
* <ul>
* <li> contextloader: child-first.
diff --git
a/src/test/java/org/apache/commons/logging/pathable/GeneralTestCase.java
b/src/test/java/org/apache/commons/logging/pathable/GeneralTestCase.java
index ca52cba..167db44 100644
--- a/src/test/java/org/apache/commons/logging/pathable/GeneralTestCase.java
+++ b/src/test/java/org/apache/commons/logging/pathable/GeneralTestCase.java
@@ -57,7 +57,7 @@ public class GeneralTestCase extends TestCase {
}
/**
- * Set up a custom classloader hierarchy for this test case.
+ * Sets up a custom classloader hierarchy for this test case.
*/
public static Test suite() throws Exception {
final Class thisClass = GeneralTestCase.class;
diff --git
a/src/test/java/org/apache/commons/logging/pathable/ParentFirstTestCase.java
b/src/test/java/org/apache/commons/logging/pathable/ParentFirstTestCase.java
index 4c713c2..c2c2c43 100644
--- a/src/test/java/org/apache/commons/logging/pathable/ParentFirstTestCase.java
+++ b/src/test/java/org/apache/commons/logging/pathable/ParentFirstTestCase.java
@@ -45,7 +45,7 @@ import org.apache.commons.logging.PathableTestSuite;
public class ParentFirstTestCase extends TestCase {
/**
- * Set up a custom classloader hierarchy for this test case.
+ * Sets up a custom classloader hierarchy for this test case.
* The hierarchy is:
* <ul>
* <li> contextloader: parent-first.
diff --git
a/src/test/java/org/apache/commons/logging/simple/CustomConfigTestCase.java
b/src/test/java/org/apache/commons/logging/simple/CustomConfigTestCase.java
index 21aee0c..611950e 100644
--- a/src/test/java/org/apache/commons/logging/simple/CustomConfigTestCase.java
+++ b/src/test/java/org/apache/commons/logging/simple/CustomConfigTestCase.java
@@ -178,7 +178,7 @@ public class CustomConfigTestCase extends
DefaultConfigTestCase {
}
/**
- * Set system properties that will control the LogFactory/Log objects
+ * Sets system properties that will control the LogFactory/Log objects
* when they are created. Subclasses can override this method to
* define properties that suit them.
*/
@@ -193,7 +193,7 @@ public class CustomConfigTestCase extends
DefaultConfigTestCase {
}
/**
- * Set up instance variables required by this test case.
+ * Sets up instance variables required by this test case.
*/
@Override
public void setUp() throws Exception {
diff --git
a/src/test/java/org/apache/commons/logging/simple/DateTimeCustomConfigTestCase.java
b/src/test/java/org/apache/commons/logging/simple/DateTimeCustomConfigTestCase.java
index 7e9de24..3b5d6f0 100644
---
a/src/test/java/org/apache/commons/logging/simple/DateTimeCustomConfigTestCase.java
+++
b/src/test/java/org/apache/commons/logging/simple/DateTimeCustomConfigTestCase.java
@@ -82,7 +82,7 @@ public class DateTimeCustomConfigTestCase extends
CustomConfigTestCase {
// ----------------------------------------------------------- Methods
/**
- * Set up system properties required by this unit test. Here, we
+ * Sets up system properties required by this unit test. Here, we
* set up the props defined in the parent class setProperties method,
* and add a few to configure the SimpleLog class date/time output.
*/
@@ -99,7 +99,7 @@ public class DateTimeCustomConfigTestCase extends
CustomConfigTestCase {
}
/**
- * Set up instance variables required by this test case.
+ * Sets up instance variables required by this test case.
*/
@Override
public void setUp() throws Exception {
diff --git
a/src/test/java/org/apache/commons/logging/simple/DefaultConfigTestCase.java
b/src/test/java/org/apache/commons/logging/simple/DefaultConfigTestCase.java
index d2d887d..936f1f9 100644
--- a/src/test/java/org/apache/commons/logging/simple/DefaultConfigTestCase.java
+++ b/src/test/java/org/apache/commons/logging/simple/DefaultConfigTestCase.java
@@ -121,7 +121,7 @@ public class DefaultConfigTestCase extends TestCase {
}
/**
- * Set system properties that will control the LogFactory/Log objects
+ * Sets system properties that will control the LogFactory/Log objects
* when they are created. Subclasses can override this method to
* define properties that suit them.
*/
@@ -132,7 +132,7 @@ public class DefaultConfigTestCase extends TestCase {
}
/**
- * Set up instance variables required by this test case.
+ * Sets up instance variables required by this test case.
*/
@Override
public void setUp() throws Exception {
diff --git
a/src/test/java/org/apache/commons/logging/tccl/log/TcclDisabledTestCase.java
b/src/test/java/org/apache/commons/logging/tccl/log/TcclDisabledTestCase.java
index ee0d15d..4241ac1 100644
---
a/src/test/java/org/apache/commons/logging/tccl/log/TcclDisabledTestCase.java
+++
b/src/test/java/org/apache/commons/logging/tccl/log/TcclDisabledTestCase.java
@@ -89,7 +89,7 @@ public class TcclDisabledTestCase extends TestCase {
}
/**
- * Set up instance variables required by this test case.
+ * Sets up instance variables required by this test case.
*/
@Override
public void setUp() throws Exception {
diff --git
a/src/test/java/org/apache/commons/logging/tccl/log/TcclEnabledTestCase.java
b/src/test/java/org/apache/commons/logging/tccl/log/TcclEnabledTestCase.java
index a9f769d..3f65cad 100644
--- a/src/test/java/org/apache/commons/logging/tccl/log/TcclEnabledTestCase.java
+++ b/src/test/java/org/apache/commons/logging/tccl/log/TcclEnabledTestCase.java
@@ -89,7 +89,7 @@ public class TcclEnabledTestCase extends TestCase {
}
/**
- * Set up instance variables required by this test case.
+ * Sets up instance variables required by this test case.
*/
@Override
public void setUp() throws Exception {
diff --git
a/src/test/java/org/apache/commons/logging/tccl/logfactory/TcclDisabledTestCase.java
b/src/test/java/org/apache/commons/logging/tccl/logfactory/TcclDisabledTestCase.java
index 487e020..57144fe 100644
---
a/src/test/java/org/apache/commons/logging/tccl/logfactory/TcclDisabledTestCase.java
+++
b/src/test/java/org/apache/commons/logging/tccl/logfactory/TcclDisabledTestCase.java
@@ -91,7 +91,7 @@ public class TcclDisabledTestCase extends TestCase {
}
/**
- * Set up instance variables required by this test case.
+ * Sets up instance variables required by this test case.
*/
@Override
public void setUp() throws Exception {
diff --git
a/src/test/java/org/apache/commons/logging/tccl/logfactory/TcclEnabledTestCase.java
b/src/test/java/org/apache/commons/logging/tccl/logfactory/TcclEnabledTestCase.java
index 9a12def..f756fa5 100644
---
a/src/test/java/org/apache/commons/logging/tccl/logfactory/TcclEnabledTestCase.java
+++
b/src/test/java/org/apache/commons/logging/tccl/logfactory/TcclEnabledTestCase.java
@@ -85,7 +85,7 @@ public class TcclEnabledTestCase extends TestCase {
}
/**
- * Set up instance variables required by this test case.
+ * Sets up instance variables required by this test case.
*/
@Override
public void setUp() throws Exception {
