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-configuration.git
The following commit(s) were added to refs/heads/master by this push:
new 70e6ef82f Javadoc
70e6ef82f is described below
commit 70e6ef82f12fef5b45de827d1a23bed5d137b998
Author: Gary Gregory <[email protected]>
AuthorDate: Fri Apr 3 09:17:54 2026 -0400
Javadoc
---
.../commons/configuration2/AbstractConfiguration.java | 2 +-
.../commons/configuration2/INIConfiguration.java | 18 +++++++++---------
.../configuration2/builder/INIBuilderProperties.java | 6 +++---
.../configuration2/builder/XMLBuilderProperties.java | 4 ++--
.../configuration2/resolver/CatalogResolver.java | 2 +-
.../commons/configuration2/io/TestFileHandler.java | 2 +-
6 files changed, 17 insertions(+), 17 deletions(-)
diff --git
a/src/main/java/org/apache/commons/configuration2/AbstractConfiguration.java
b/src/main/java/org/apache/commons/configuration2/AbstractConfiguration.java
index 2cc4e7fef..73bdfe9ee 100644
--- a/src/main/java/org/apache/commons/configuration2/AbstractConfiguration.java
+++ b/src/main/java/org/apache/commons/configuration2/AbstractConfiguration.java
@@ -1385,7 +1385,7 @@ public abstract class AbstractConfiguration extends
BaseEventSource implements C
}
/**
- * Allows setting the logger to be used by this configuration object. This
method makes it possible for clients to
+ * Sets the logger to be used by this configuration object. This method
makes it possible for clients to
* exactly control logging behavior. Per default a logger is set that will
ignore all log messages. Derived classes that
* want to enable logging should call this method during their
initialization with the logger to be used. It is legal to
* pass a <strong>null</strong> logger; in this case, logging will be
disabled.
diff --git
a/src/main/java/org/apache/commons/configuration2/INIConfiguration.java
b/src/main/java/org/apache/commons/configuration2/INIConfiguration.java
index a493f20e5..2d8ac3d26 100644
--- a/src/main/java/org/apache/commons/configuration2/INIConfiguration.java
+++ b/src/main/java/org/apache/commons/configuration2/INIConfiguration.java
@@ -599,7 +599,7 @@ public class INIConfiguration extends
BaseHierarchicalConfiguration implements F
}
/**
- * Tries to find the index of the separator character in the given string.
This method checks for the presence of
+ * Finds the index of the separator character in the given string. This
method checks for the presence of
* separator characters in the given string. If multiple characters are
found, the first one is assumed to be the
* correct separator. If there are quoting characters, they are taken into
account, too.
*
@@ -729,7 +729,7 @@ public class INIConfiguration extends
BaseHierarchicalConfiguration implements F
}
/**
- * Determine if the given line is a comment line.
+ * Tests if the given line is a comment line.
*
* @param line The line to check.
* @return true if the line is empty or starts with one of the comment
characters
@@ -743,7 +743,7 @@ public class INIConfiguration extends
BaseHierarchicalConfiguration implements F
}
/**
- * Determine if the given line is a section.
+ * Tests if the given line is a section.
*
* @param line The line to check.
* @return true if the line contains a section
@@ -781,7 +781,7 @@ public class INIConfiguration extends
BaseHierarchicalConfiguration implements F
}
/**
- * Parse the value to remove the quotes and ignoring the comment. Example:
+ * Parses the value to remove the quotes and ignoring the comment. Example:
*
* <pre>
* "value" ; comment -> value
@@ -868,7 +868,7 @@ public class INIConfiguration extends
BaseHierarchicalConfiguration implements F
}
/**
- * Load the configuration from the given reader. Note that the {@code
clear()} method is not called so the configuration
+ * Reads the configuration from the given reader. Note that the {@code
clear()} method is not called so the configuration
* read in will be merged with the current configuration.
*
* @param in the reader to read the configuration from.
@@ -887,7 +887,7 @@ public class INIConfiguration extends
BaseHierarchicalConfiguration implements F
}
/**
- * Allows setting the leading comment separator which is used in reading
an INI file
+ * Sets the leading comment separator which is used in reading an INI file
*
* @param separator String of the new separator for INI reading
* @since 2.5
@@ -902,7 +902,7 @@ public class INIConfiguration extends
BaseHierarchicalConfiguration implements F
}
/**
- * Allows setting the key and value separator which is used in reading an
INI file
+ * Sets the key and value separator which is used in reading an INI file
*
* @param separator String of the new separator for INI reading
* @since 2.5
@@ -917,7 +917,7 @@ public class INIConfiguration extends
BaseHierarchicalConfiguration implements F
}
/**
- * Allows setting the key and value separator which is used for the
creation of the resulting INI output
+ * Sets the key and value separator which is used for the creation of the
resulting INI output
*
* @param separator String of the new separator for INI output
* @since 2.2
@@ -927,7 +927,7 @@ public class INIConfiguration extends
BaseHierarchicalConfiguration implements F
}
/**
- * Save the configuration to the specified writer.
+ * Writes the configuration to the specified writer.
*
* @param writer The writer to save the configuration to.
* @throws ConfigurationException If an error occurs while writing the
configuration
diff --git
a/src/main/java/org/apache/commons/configuration2/builder/INIBuilderProperties.java
b/src/main/java/org/apache/commons/configuration2/builder/INIBuilderProperties.java
index 23bc9c143..e2866e1e7 100644
---
a/src/main/java/org/apache/commons/configuration2/builder/INIBuilderProperties.java
+++
b/src/main/java/org/apache/commons/configuration2/builder/INIBuilderProperties.java
@@ -34,7 +34,7 @@ package org.apache.commons.configuration2.builder;
public interface INIBuilderProperties<T> {
/**
- * Allows setting the leading comment separator which is used in reading
an INI file.
+ * Sets the leading comment separator which is used in reading an INI file.
*
* @param separator String of the new separator for INI reading
* @return a reference to this object for method chaining
@@ -46,7 +46,7 @@ public interface INIBuilderProperties<T> {
}
/**
- * Allows setting the key and value separator which is used in reading an
INI file.
+ * Sets the key and value separator which is used in reading an INI file.
*
* @param separator String of the new separator for INI reading
* @return a reference to this object for method chaining
@@ -58,7 +58,7 @@ public interface INIBuilderProperties<T> {
}
/**
- * Allows setting the separator between key and value to be used when
writing an INI file.
+ * Sets the separator between key and value to be used when writing an INI
file.
*
* @param separator the new separator for INI output
* @return a reference to this object for method chaining
diff --git
a/src/main/java/org/apache/commons/configuration2/builder/XMLBuilderProperties.java
b/src/main/java/org/apache/commons/configuration2/builder/XMLBuilderProperties.java
index a98b54d0a..0fbdd582f 100644
---
a/src/main/java/org/apache/commons/configuration2/builder/XMLBuilderProperties.java
+++
b/src/main/java/org/apache/commons/configuration2/builder/XMLBuilderProperties.java
@@ -38,7 +38,7 @@ import org.xml.sax.EntityResolver;
public interface XMLBuilderProperties<T> {
/**
- * Allows setting the {@code DocumentBuilder} for parsing an XML document.
This is the most flexible way of customizing
+ * Sets the {@code DocumentBuilder} for parsing an XML document. This is
the most flexible way of customizing
* XML processing.
*
* @param docBuilder the {@code DocumentBuilder} to use
@@ -47,7 +47,7 @@ public interface XMLBuilderProperties<T> {
T setDocumentBuilder(DocumentBuilder docBuilder);
/**
- * Allows setting the {@code EntityResolver} which maps entity references
during XML parsing.
+ * Sets the {@code EntityResolver} which maps entity references during XML
parsing.
*
* @param resolver the {@code EntityResolver} to use
* @return a reference to this object for method chaining
diff --git
a/src/main/java/org/apache/commons/configuration2/resolver/CatalogResolver.java
b/src/main/java/org/apache/commons/configuration2/resolver/CatalogResolver.java
index 241f4f4c5..dcdeb53fb 100644
---
a/src/main/java/org/apache/commons/configuration2/resolver/CatalogResolver.java
+++
b/src/main/java/org/apache/commons/configuration2/resolver/CatalogResolver.java
@@ -482,7 +482,7 @@ public class CatalogResolver implements EntityResolver {
}
/**
- * Allows setting the logger to be used by this object. This method makes
it possible for clients to exactly control
+ * Sets the logger to be used by this object. This method makes it
possible for clients to exactly control
* logging behavior. Per default a logger is set that will ignore all log
messages. Derived classes that want to enable
* logging should call this method during their initialization with the
logger to be used. Passing in <strong>null</strong> as
* argument disables logging.
diff --git
a/src/test/java/org/apache/commons/configuration2/io/TestFileHandler.java
b/src/test/java/org/apache/commons/configuration2/io/TestFileHandler.java
index 5aea041f2..5f9b676c9 100644
--- a/src/test/java/org/apache/commons/configuration2/io/TestFileHandler.java
+++ b/src/test/java/org/apache/commons/configuration2/io/TestFileHandler.java
@@ -145,7 +145,7 @@ public class TestFileHandler {
}
/**
- * Allows setting the content.
+ * Sets the content.
*
* @param content the content
*/
