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
commit 76a6757e689e9c31632cc395c37036824368635d Author: Gary Gregory <[email protected]> AuthorDate: Sun Oct 29 07:44:18 2023 -0400 Fix Javadoc errors (Java 21) --- .github/workflows/maven.yml | 2 +- .../org/apache/commons/configuration2/DatabaseConfiguration.java | 5 +++-- .../java/org/apache/commons/configuration2/INIConfiguration.java | 5 +++-- .../builder/combined/CombinedConfigurationBuilder.java | 8 ++++---- .../commons/configuration2/builder/fluent/package-info.java | 2 +- .../org/apache/commons/configuration2/builder/package-info.java | 2 +- 6 files changed, 13 insertions(+), 11 deletions(-) diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml index 309809ba..a6f553e2 100644 --- a/.github/workflows/maven.yml +++ b/.github/workflows/maven.yml @@ -44,6 +44,6 @@ jobs: java-version: ${{ matrix.java }} cache: 'maven' - name: Build with Maven - run: mvn --show-version --batch-mode --no-transfer-progress -Ddoclint=none + run: mvn --show-version --batch-mode --no-transfer-progress # For Java 11, you can be more strict: -DadditionalJOption=-Xdoclint/package:-org.apache.commons.configuration2.plist diff --git a/src/main/java/org/apache/commons/configuration2/DatabaseConfiguration.java b/src/main/java/org/apache/commons/configuration2/DatabaseConfiguration.java index 373bbb3c..28e16cee 100644 --- a/src/main/java/org/apache/commons/configuration2/DatabaseConfiguration.java +++ b/src/main/java/org/apache/commons/configuration2/DatabaseConfiguration.java @@ -109,8 +109,9 @@ import org.apache.commons.lang3.StringUtils; * {@code commits} parameter of the constructors to <b>true</b>. If commits should not be performed (which is the * default behavior), it should be ensured that the connections returned by the {@code DataSource} are in auto-commit * mode. - * - * <h1>Note: Like JDBC itself, protection against SQL injection is left to the user.</h1> + * <p> + * <strong>Note: Like JDBC itself, protection against SQL injection is left to the user.</strong> + * </p> * * @since 1.0 */ diff --git a/src/main/java/org/apache/commons/configuration2/INIConfiguration.java b/src/main/java/org/apache/commons/configuration2/INIConfiguration.java index 54b88dc6..b2ef6e26 100644 --- a/src/main/java/org/apache/commons/configuration2/INIConfiguration.java +++ b/src/main/java/org/apache/commons/configuration2/INIConfiguration.java @@ -103,8 +103,9 @@ import org.apache.commons.configuration2.tree.TrackedNodeModel; * Because this is a hierarchical configuration you can change this by setting a different * {@link org.apache.commons.configuration2.tree.ExpressionEngine}.) * </p> - * <h3>Implementation Details:</h3> Consider the following ini file: - * + * <p> + * <strong>Implementation Details:</strong> Consider the following ini file: + * </p> * <pre> * default = ok * diff --git a/src/main/java/org/apache/commons/configuration2/builder/combined/CombinedConfigurationBuilder.java b/src/main/java/org/apache/commons/configuration2/builder/combined/CombinedConfigurationBuilder.java index f1cb960d..dc625929 100644 --- a/src/main/java/org/apache/commons/configuration2/builder/combined/CombinedConfigurationBuilder.java +++ b/src/main/java/org/apache/commons/configuration2/builder/combined/CombinedConfigurationBuilder.java @@ -124,23 +124,23 @@ import org.xml.sax.EntityResolver; * <th>Meaning</th> * </tr> * <tr> - * <td valign="top">{@code config-name}</td> + * <td>{@code config-name}</td> * <td>Allows specifying a name for this configuration. This name can be used to obtain a reference to the configuration * from the resulting combined configuration (see below). It can also be passed to the {@link #getNamedBuilder(String)} * method.</td> * </tr> * <tr> - * <td valign="top">{@code config-at}</td> + * <td>{@code config-at}</td> * <td>With this attribute an optional prefix can be specified for the properties of the corresponding * configuration.</td> * </tr> * <tr> - * <td valign="top">{@code config-optional}</td> + * <td>{@code config-optional}</td> * <td>Declares a configuration source as optional. This means that errors that occur when creating the configuration * are ignored.</td> * </tr> * <tr> - * <td valign="top">{@code config-reload}</td> + * <td>{@code config-reload}</td> * <td>Many configuration sources support a reloading mechanism. For those sources it is possible to enable reloading by * providing this attribute with a value of <strong>true</strong>.</td> * </tr> diff --git a/src/main/java/org/apache/commons/configuration2/builder/fluent/package-info.java b/src/main/java/org/apache/commons/configuration2/builder/fluent/package-info.java index dccaafc3..b417dae3 100644 --- a/src/main/java/org/apache/commons/configuration2/builder/fluent/package-info.java +++ b/src/main/java/org/apache/commons/configuration2/builder/fluent/package-info.java @@ -24,7 +24,7 @@ * to create various parameters objects defining the settings for a configuration builder. These objects define * {@code set} methods allowing the manipulation of all available initialization properties. * </p> - * <h3>Important note</h3> + * <strong>Important note</strong> * <p> * <strong>This package contains a number of interfaces that reflect the initialization parameters available for * supported configuration implementations. These interfaces are not intended to be implemented by client code! When new diff --git a/src/main/java/org/apache/commons/configuration2/builder/package-info.java b/src/main/java/org/apache/commons/configuration2/builder/package-info.java index 891aa827..4bb4fd26 100644 --- a/src/main/java/org/apache/commons/configuration2/builder/package-info.java +++ b/src/main/java/org/apache/commons/configuration2/builder/package-info.java @@ -27,7 +27,7 @@ * Each component requiring access to configuration information queries the builder for its managed * {@code Configuration} and can read or write properties as its pleasure. * </p> - * <h3>Important note</h3> + * <strong>Important note</strong> * <p> * <strong>This package contains a number of interfaces that reflect the initialization parameters available for * supported configuration implementations. These interfaces are not intended to be implemented by client code! When new
