You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2021/01/22 18:40:21 UTC

[commons-configuration] branch master updated: Javadoc: Sentences end in a period.

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 150d7aa  Javadoc: Sentences end in a period.
150d7aa is described below

commit 150d7aac8d767d21064ef38557f4b9f4a59f79f1
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Fri Jan 22 13:40:15 2021 -0500

    Javadoc: Sentences end in a period.
---
 .../java/org/apache/commons/configuration2/INIConfiguration.java    | 6 +++---
 .../org/apache/commons/configuration2/PropertiesConfiguration.java  | 6 +++---
 src/main/java/org/apache/commons/configuration2/io/FileBased.java   | 4 ++--
 .../org/apache/commons/configuration2/io/InputStreamSupport.java    | 2 +-
 .../TestReloadingCombinedConfigurationBuilderFileBased.java         | 2 +-
 5 files changed, 10 insertions(+), 10 deletions(-)

diff --git a/src/main/java/org/apache/commons/configuration2/INIConfiguration.java b/src/main/java/org/apache/commons/configuration2/INIConfiguration.java
index 1b93946..2b47f17 100644
--- a/src/main/java/org/apache/commons/configuration2/INIConfiguration.java
+++ b/src/main/java/org/apache/commons/configuration2/INIConfiguration.java
@@ -408,7 +408,7 @@ public class INIConfiguration extends BaseHierarchicalConfiguration implements
      * @param writer - The writer to save the configuration to.
      * @throws ConfigurationException If an error occurs while writing the
      *         configuration
-     * @throws IOException if an I/O error occurs
+     * @throws IOException if an I/O error occurs.
      */
     @Override
     public void write(final Writer writer) throws ConfigurationException, IOException
@@ -463,7 +463,7 @@ public class INIConfiguration extends BaseHierarchicalConfiguration implements
      * @param in the reader to read the configuration from.
      * @throws ConfigurationException If an error occurs while reading the
      *         configuration
-     * @throws IOException if an I/O error occurs
+     * @throws IOException if an I/O error occurs.
      */
     @Override
     public void read(final Reader in) throws ConfigurationException, IOException
@@ -505,7 +505,7 @@ public class INIConfiguration extends BaseHierarchicalConfiguration implements
      * @param in the reader
      * @param rootBuilder the builder for the top-level section
      * @param sectionBuilders a map storing the section builders
-     * @throws IOException if an I/O error occurs
+     * @throws IOException if an I/O error occurs.
      */
     private void createNodeBuilders(final BufferedReader in,
             final ImmutableNode.Builder rootBuilder,
diff --git a/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java b/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java
index 8df6738..42c08e1 100644
--- a/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java
+++ b/src/main/java/org/apache/commons/configuration2/PropertiesConfiguration.java
@@ -1060,7 +1060,7 @@ public class PropertiesConfiguration extends BaseConfiguration
          * Write a comment.
          *
          * @param comment the comment to write
-         * @throws IOException if an I/O error occurs
+         * @throws IOException if an I/O error occurs.
          */
         public void writeComment(final String comment) throws IOException
         {
@@ -1090,7 +1090,7 @@ public class PropertiesConfiguration extends BaseConfiguration
          * @param key The key of the property
          * @param values The array of values of the property
          *
-         * @throws IOException if an I/O error occurs
+         * @throws IOException if an I/O error occurs.
          */
         public void writeProperty(final String key, final List<?> values) throws IOException
         {
@@ -1105,7 +1105,7 @@ public class PropertiesConfiguration extends BaseConfiguration
          * @param key the key of the property
          * @param value the value of the property
          *
-         * @throws IOException if an I/O error occurs
+         * @throws IOException if an I/O error occurs.
          */
         public void writeProperty(final String key, final Object value) throws IOException
         {
diff --git a/src/main/java/org/apache/commons/configuration2/io/FileBased.java b/src/main/java/org/apache/commons/configuration2/io/FileBased.java
index 1531793..f92da0e 100644
--- a/src/main/java/org/apache/commons/configuration2/io/FileBased.java
+++ b/src/main/java/org/apache/commons/configuration2/io/FileBased.java
@@ -53,7 +53,7 @@ public interface FileBased
      * {@code FileHandler} for reading data.</strong>
      *
      * @param in the reader
-     * @throws IOException if an I/O error occurs
+     * @throws IOException if an I/O error occurs.
      * @throws ConfigurationException if a non-I/O related problem occurs, e.g.
      *         the data read does not have the expected format
      */
@@ -65,7 +65,7 @@ public interface FileBased
      * {@code FileHandler} for writing data.</strong>
      *
      * @param out the writer
-     * @throws IOException if an I/O error occurs
+     * @throws IOException if an I/O error occurs.
      * @throws ConfigurationException if a non-I/O related problem occurs, e.g.
      *         the data read does not have the expected format
      */
diff --git a/src/main/java/org/apache/commons/configuration2/io/InputStreamSupport.java b/src/main/java/org/apache/commons/configuration2/io/InputStreamSupport.java
index 8d471d4..869fd5d 100644
--- a/src/main/java/org/apache/commons/configuration2/io/InputStreamSupport.java
+++ b/src/main/java/org/apache/commons/configuration2/io/InputStreamSupport.java
@@ -47,7 +47,7 @@ public interface InputStreamSupport
      * @param in the input stream
      * @throws ConfigurationException if a non-I/O related problem occurs, e.g.
      *         the data read does not have the expected format
-     * @throws IOException if an I/O error occurs
+     * @throws IOException if an I/O error occurs.
      */
     void read(InputStream in) throws ConfigurationException, IOException;
 }
diff --git a/src/test/java/org/apache/commons/configuration2/builder/combined/TestReloadingCombinedConfigurationBuilderFileBased.java b/src/test/java/org/apache/commons/configuration2/builder/combined/TestReloadingCombinedConfigurationBuilderFileBased.java
index 35ac8eb..f630e13 100644
--- a/src/test/java/org/apache/commons/configuration2/builder/combined/TestReloadingCombinedConfigurationBuilderFileBased.java
+++ b/src/test/java/org/apache/commons/configuration2/builder/combined/TestReloadingCombinedConfigurationBuilderFileBased.java
@@ -261,7 +261,7 @@ public class TestReloadingCombinedConfigurationBuilderFileBased
      * initialized.
      *
      * @param defFile the path to the definition file
-     * @throws IOException if an I/O error occurs
+     * @throws IOException if an I/O error occurs.
      * @throws ConfigurationException if a configuration-related error occurs
      * @throws InterruptedException if waiting is interrupted
      */