Improve Javadoc.

Signed-off-by: Franz Wilhelmstötter <franz.wilhelmstoetter@gmail.com>

Author: jenetics

facilejdbc/src/main/java/io/jenetics/facilejdbc/Lifecycle.java

@@ -46,7 +46,7 @@ final class Lifecycle {
 	/**
 	 * Runnable task/method, which might throw an exception {@code E}.
 	 *
-	 * @param <E> the exception which might be thrown
+	 * @param <E> the exception, which might be thrown
 	 */
 	@FunctionalInterface
 	public interface ThrowingRunnable<E extends Exception> {
@@ -183,7 +183,7 @@ default void silentClose(final Throwable previousError) {
 
 		/**
 		 * Create a new {@code ExtendedCloseable} object with the given initial
-		 * release <em>methods</em>. The given list of objects are closed in
+		 * release <em>methods</em>. The given list of objects is closed in
 		 * reversed order.
 		 *
 		 * @see #of(ThrowingRunnable...)
@@ -206,7 +206,7 @@ default void silentClose(final Throwable previousError) {
 
 		/**
 		 * Create a new {@code ExtendedCloseable} object with the given initial
-		 * release <em>methods</em>. The given list of objects are closed in
+		 * release <em>methods</em>. The given list of objects is closed in
 		 * reversed order.
 		 *
 		 * @see #of(Collection)
@@ -230,7 +230,7 @@ default void silentClose(final Throwable previousError) {
 	 * This class represents a <em>closeable</em> value. It is useful in cases
 	 * where the object value doesn't implement the {@link AutoCloseable}
 	 * interface but needs some cleanup work to do after usage. In the following
-	 * example the create {@code file} is automatically deleted when leaving the
+	 * example the created {@code file} is automatically deleted when leaving the
 	 * {@code try} block.
 	 *
 	 * <pre>{@code
@@ -286,7 +286,7 @@ public String toString() {
 
 		/**
 		 * Applies the give {@code block} to the already created closeable value.
-		 * If the {@code block} throws an exception, the  resource value is
+		 * If the {@code block} throws an exception, the resource value is
 		 * released, by calling the defined <em>release</em> method. The typical
 		 * use case for this method is when additional initialization of the
 		 * value is needed.
@@ -372,7 +372,7 @@ public static <T, E extends Exception> Value<T, E> of(
 		 *
 		 * @param builder the builder method
 		 * @param <T> the value type of the created <em>closeable</em> value
-		 * @param <BE> the exception type which might be thrown while building
+		 * @param <BE> the exception type, which might be thrown while building
 		 *             the value
 		 * @param <VE> the exception type which might be thrown when releasing
 		 *              the returned <em>closeable</em> value
@@ -408,10 +408,10 @@ public static <T, E extends Exception> Value<T, E> of(
 	}
 
 	/**
-	 * This class allows to collect one or more {@link AutoCloseable} objects
+	 * This class allows collecting one or more {@link AutoCloseable} objects
 	 * into one. The registered closeable objects are closed in reverse order.
 	 * <p>
-	 * Using the {@code Resources} class can simplify the the creation of
+	 * Using the {@code Resources} class can simplify the creation of
 	 * dependent input streams, where it might be otherwise necessary to create
 	 * nested {@code try-with-resources} blocks.
 	 *
@@ -470,7 +470,7 @@ public Resources() {
 		 * resources.
 		 *
 		 * @param resource the new resource to register
-		 * @param release the method, which <em>releases</em> the the acquired
+		 * @param release the method, which <em>releases</em> the acquired
 		 *        resource
 		 * @param <C> the resource type
 		 * @return the registered resource

facilejdbc/src/main/java/io/jenetics/facilejdbc/ParamValues.java

@@ -26,7 +26,7 @@
 import java.util.List;
 
 /**
- * This represents a whole Sql row (parameter set). Instead of representing the
+ * This represents a whole SQL row (parameter set). Instead of representing the
  * row directly, a row is defined it's <em>insertion</em> strategy.
  *
  * @see SingleParam

facilejdbc/src/main/java/io/jenetics/facilejdbc/PreparedQuery.java

@@ -28,7 +28,7 @@
 
 /**
  * A prepared query has a {@link PreparedStatement} attached and lets you do
- * batch inserts in a convenient way.
+ * batch inserts conveniently.
  *
  * @author <a href="mailto:franz.wilhelmstoetter@gmail.com">Franz Wilhelmstötter</a>
  * @version 2.1

facilejdbc/src/main/java/io/jenetics/facilejdbc/Query.java

@@ -527,7 +527,7 @@ private static <K> Optional<K> readId(
 
 	/**
 	 * Executes the SQL statement in a {@link PreparedStatement} object, which
-	 * must be an SQL {@code INSERT}. It returns, the optionally generated, key
+	 * must be an SQL {@code INSERT}. It returns the optionally generated, key
 	 * for the inserted row.
 	 *
 	 * @see PreparedStatement#executeUpdate()

facilejdbc/src/main/java/io/jenetics/facilejdbc/Records.java

@@ -98,7 +98,7 @@ private Records() {
 	 * @param type the record type to deconstruct
 	 * @param toColumnName function for mapping the record component to the
 	 *        column names of the DB
-	 * @param fields The fields which overrides/extends the
+	 * @param fields The fields that override/extend the
 	 *        automatically extracted fields from the record. It also allows
 	 *        defining additional column values, derived from the given record
 	 *        values.
@@ -178,7 +178,7 @@ private static <T extends Record> Dctor.Field<? super T> toFiled(
 	 * @param type the record type to deconstruct
 	 * @param toColumnName function for mapping the record component to the
 	 *        column names of the DB
-	 * @param fields The fields which overrides/extends the
+	 * @param fields The fields that override/extend the
 	 *        automatically extracted fields from the record. It also allows
 	 *        defining additional column values, derived from the given record
 	 *        values.
@@ -225,7 +225,7 @@ public static <T extends Record> Dctor<T> dctor(
 	 * @see Dctor#of(Class, Dctor.Field[])
 	 *
 	 * @param type the record type to deconstruct
-	 * @param fields The fields which overrides/extends the
+	 * @param fields The fields that override/extend the
 	 *        automatically extracted fields from the record. It also allows
 	 *        defining additional column values, derived from the given record
 	 *        values.
@@ -243,7 +243,7 @@ public static <T extends Record> Dctor<T> dctor(
 	}
 
 	/**
-	 * Converts to given a record component to a column name in
+	 * Converts to give a record component to a column name in
 	 * <a href="https://en.wikipedia.org/wiki/Snake_case">snake_case</a>.
 	 *
 	 * @see #toSnakeCase(String)

facilejdbc/src/main/java/io/jenetics/facilejdbc/Transaction.java

@@ -119,7 +119,7 @@ default void accept(final SqlConsumer<? super Connection> block)
 	 * }</pre>
 	 *
 	 * @apiNote
-	 * This method implements the transactional default behaviour ot the
+	 * This method implements the transactional default behavior of the
 	 * {@link Transaction} implementation, returned by the
 	 * {@link Transactional#transaction()} interface.
 	 *

facilejdbc/src/main/java/io/jenetics/facilejdbc/Transactional.java

@@ -114,7 +114,7 @@
 public interface Transactional {
 
 	/**
-	 * Return the DB connection. If you obtain a new connection, you are
+	 * Return the DB connection. If you get a new connection, you are
 	 * responsible for closing it after usage. This is done ideally in a
 	 * resource-try block.
 	 *
@@ -128,17 +128,17 @@ public interface Transactional {
 	 *
 	 * You are usually using the {@link #transaction()} method for getting an
 	 * instance of the {@link Transaction} interface, which is then using this
-	 * method for obtaining the needed connections.
+	 * method for getting the necessary connections.
 	 *
 	 * @see #transaction()
 	 *
 	 * @return the DB connection
-	 * @throws SQLException if obtaining a DB connection fails
+	 * @throws SQLException if getting a DB connection fails
 	 */
 	Connection connection() throws SQLException;
 
 	/**
-	 * Return a <em>Transaction</em> object, which obtains the connection,
+	 * Return a <em>Transaction</em> object, which gets the connection,
 	 * needed for executing a query, from the {@link #connection()} factory
 	 * method. The transactional behavior is defined by the
 	 * {@link #txm(Connection, SqlSupplier)} method of {@code this} interface.

facilejdbc/src/main/java/io/jenetics/facilejdbc/function/package-info.java

@@ -19,7 +19,7 @@
  */
 
 /**
- * Contains all needed functional interfaces, which may throw a
+ * Contains all necessary functional interfaces, which may throw a
  * {@link java.sql.SQLException}.
  *
  * @author <a href="mailto:franz.wilhelmstoetter@gmail.com">Franz Wilhelmstötter</a>

facilejdbc/src/main/java/io/jenetics/facilejdbc/package-info.java

@@ -19,7 +19,7 @@
  */
 
 /**
- * This is the base package of the JDBC wrapper and contains all needed
+ * This is the base package of the JDBC wrapper and contains all necessary
  * interfaces and the {@link io.jenetics.facilejdbc.Query} class. An overview
  * of the purpose and functionality of the <em>FacileJDBC</em> library can be
  * found <a href="https://github.com/jenetics/facilejdbc/blob/master/README.md">here</a>.

facilejdbc/src/main/java/io/jenetics/facilejdbc/spi/SqlTypeMapper.java

@@ -22,7 +22,6 @@
 /**
  * The purpose of this SPI is to map simple <em>domain</em> values into the
  * proper type of the used DB. This may lead to a more readable insertion code.
- *
  * Usually, it is not possible to insert an {@code URI} field directly into the
  * DB. You have to convert it into a string object first.
  * <pre>{@code