fixing javadoc

jklingsporn · Dec 18, 2020 · 510f38f · 510f38f
1 parent 3d4d4fd
commit 510f38f
Show file tree

Hide file tree

Showing 8 changed files with 36 additions and 36 deletions.
diff --git a/...d/src/main/java/io/github/jklingsporn/vertx/jooq/shared/internal/AbstractQueryResult.java b/...d/src/main/java/io/github/jklingsporn/vertx/jooq/shared/internal/AbstractQueryResult.java
@@ -12,8  12,8 @@ public abstract class AbstractQueryResult implements QueryResult{
 
     /**
      *
-     * @param supplier
-     * @param <T>
      * @param supplier the supplier to return they type
      * @param <T> the return type
      * @return the value supplied by supplier or throw a NoSuchElementException if the
      * underlying result has no results.
      */

diff --git a/...ared/src/main/java/io/github/jklingsporn/vertx/jooq/shared/internal/AbstractVertxDAO.java b/...ared/src/main/java/io/github/jklingsporn/vertx/jooq/shared/internal/AbstractVertxDAO.java
@@ -236,8  236,8 @@ protected Condition equalKeys(Collection<T> ids){
     }
 
     /**
-     * @param dslContext
-     * @param pojo
      * @param dslContext the {@link DSLContext}
      * @param pojo the pojo
      * @return a new {@code Record} based on the pojo.
      */
     protected Record newRecord(DSLContext dslContext, P pojo) {

diff --git a/...ed/src/main/java/io/github/jklingsporn/vertx/jooq/shared/internal/BasicQueryExecutor.java b/...ed/src/main/java/io/github/jklingsporn/vertx/jooq/shared/internal/BasicQueryExecutor.java
@@ -13,7  13,7 @@ public interface BasicQueryExecutor<EXECUTE> extends Attachable{
 
     /**
      * Executes a query and returns the result of the execution (usually an <code>Integer</code>-value)
-     * @param queryFunction
      * @param queryFunction the query function
      * @return the result type returned for all insert, update and delete-operations.
      * @see Query#execute()
      */

diff --git a/...hared/src/main/java/io/github/jklingsporn/vertx/jooq/shared/internal/GenericVertxDAO.java b/...hared/src/main/java/io/github/jklingsporn/vertx/jooq/shared/internal/GenericVertxDAO.java
@@ -22,14  22,14 @@ public interface GenericVertxDAO<R extends UpdatableRecord<R>,P, T, FIND_MANY, F
     /**
      * Performs an async <code>INSERT</code> statement for a given POJO. This is the same as calling
      * #insert(pojo,false).
-     * @param pojo
      * @param pojo the pojo
      * @return the result type returned for all insert, update and delete-operations.
      */
     public EXECUTE insert(P pojo);
 
     /**
      * Performs an async <code>INSERT</code> statement for a given POJO.
-     * @param pojo
      * @param pojo the pojo
      * @param onDuplicateKeyIgnore whether or not to set onDuplicateKeyIgnore option
      * @return the result type returned for all insert, update and delete-operations.
      */
@@ -38,105  38,105 @@ public interface GenericVertxDAO<R extends UpdatableRecord<R>,P, T, FIND_MANY, F
     /**
      * Performs an async <code>INSERT</code> statement for all given POJOs. This is the same as calling
      * #insert(pojos,false).
-     * @param pojos
      * @param pojos the pojos
      * @return the result type returned for all insert, update and delete-operations.
      */
     public EXECUTE insert(Collection<P> pojos);
 
     /**
      * Performs an async <code>INSERT</code> statement for all given POJOs.
-     * @param pojos
      * @param pojos the pojos
      * @param onDuplicateKeyIgnore whether or not to set onDuplicateKeyIgnore option
      * @return the result type returned for all insert, update and delete-operations.
      */
     public EXECUTE insert(Collection<P> pojos, boolean onDuplicateKeyIgnore);
 
     /**
      * Performs an async <code>INSERT</code> statement for a given POJO and returns it's primary key.
-     * @param pojo
      * @param pojo the pojo
      * @return the result type returned for INSERT_RETURNING.
      */
     public INSERT_RETURNING insertReturningPrimary(P pojo);
 
     /**
      * Performs an async <code>UPDATE</code> statement for a given POJO. For performance reasons, consider writing
      * your own update-statements by using a <code>QueryExecutor</code> directly.
-     * @param pojo
      * @param pojo the pojo
      * @return the result type returned for all insert, update and delete-operations.
      */
     public EXECUTE update(P pojo);
 
     /**
      * Performs an async <code>DELETE</code> statement using the given id
-     * @param id
      * @param id the id
      * @return the result type returned for all insert, update and delete-operations.
      */
     public EXECUTE deleteById(T id);
 
     /**
      * Performs an async <code>DELETE</code> statement using the given ids
-     * @param ids
      * @param ids the ids
      * @return the result type returned for all insert, update and delete-operations.
      */
     public EXECUTE deleteByIds(Collection<T> ids);
 
     /**
      * Performs an async <code>DELETE</code> statement using the given <code>Condition</code>
-     * @param condition
      * @param condition the query condition
      * @return the result type returned for all insert, update and delete-operations.
      */
     public EXECUTE deleteByCondition(Condition condition);
 
     /**
      * Performs an async <code>SELECT</code> using the given condition. If more than one row is found, a
      * <code>TooManyRowsException</code> is raised.
-     * @param condition
      * @param condition the query condition
      * @return the result type returned for all find-one-value-operations.
      */
     public FIND_ONE findOneByCondition(Condition condition);
 
     /**
      * Performs an async <code>SELECT</code> using the given primary key.
-     * @param id
      * @param id the id
      * @return the result type returned for all find-one-value-operations.
      */
     public FIND_ONE findOneById(T id);
 
     /**
      * Performs an async <code>SELECT</code> using the given primary keys.
-     * @param ids
      * @param ids the ids
      * @return the result type returned for all find-many-values-operations.
      */
     public FIND_MANY findManyByIds(Collection<T> ids);
 
     /**
      * Performs an async <code>SELECT</code> using the given condition.
-     * @param condition
      * @param condition the query condition
      * @return the result type returned for all find-many-values-operations.
      */
     public FIND_MANY findManyByCondition(Condition condition);
 
     /**
      * Performs an async <code>SELECT</code> using the given condition and limit.
-     * @param condition
-     * @param limit
      * @param condition the query condition
      * @param limit the limit
      * @return the result type returned for all find-many-values-operations.
      */
     public FIND_MANY findManyByCondition(Condition condition,int limit);
 
     /**
      * Performs an async <code>SELECT</code> using the given condition with specific order.
-     * @param condition
-     * @param orderFields
      * @param condition the query condition
      * @param orderFields the order fields (optional)
      * @return the result type returned for all find-many-values-operations.
      */
     public FIND_MANY findManyByCondition(Condition condition, OrderField<?> ... orderFields);
 
     /**
      * Performs an async <code>SELECT</code> using the given condition with specific order and limit.
-     * @param condition
-     * @param limit
-     * @param orderFields
      * @param condition the query condition
      * @param limit the limit
      * @param orderFields the order fields (optional)
      * @return the result type returned for all find-many-values-operations.
      */
     public FIND_MANY findManyByCondition(Condition condition, int limit, OrderField<?> ... orderFields);

diff --git a/...-shared/src/main/java/io/github/jklingsporn/vertx/jooq/shared/internal/QueryExecutor.java b/...-shared/src/main/java/io/github/jklingsporn/vertx/jooq/shared/internal/QueryExecutor.java
@@ -19,21  19,21 @@ public interface QueryExecutor<R extends UpdatableRecord<R>, T, FIND_MANY, FIND_
 
     /**
      * Runs and returns a query to return many values.
-     * @param queryFunction
      * @param queryFunction the query function
      * @return the result type returned for all find-many-values-operations.
      */
     FIND_MANY findMany(Function<DSLContext, ? extends ResultQuery<R>> queryFunction);
 
     /**
      * Runs a query and returns at most one value or <code>null</code>.
-     * @param queryFunction
      * @param queryFunction the query function
      * @return the result type returned for all find-one-value-operations.
      */
     FIND_ONE findOne(Function<DSLContext, ? extends ResultQuery<R>> queryFunction);
 
     /**
      * Performs an async <code>INSERT</code> statement for a given POJO and returns it's primary key.
-     * @param queryFunction
      * @param queryFunction the query function
      * @param keyMapper a function to map the result returned by the underlying executor into the key type.
      * @return the result type returned for INSERT_RETURNING.
      */

diff --git a/...oq-shared/src/main/java/io/github/jklingsporn/vertx/jooq/shared/internal/QueryResult.java b/...oq-shared/src/main/java/io/github/jklingsporn/vertx/jooq/shared/internal/QueryResult.java
@@ -15,7  15,7 @@ public interface QueryResult {
     /**
      * Returns a value for a {@code Field}.
      * @param field the {@code Field} to get.
-     * @param <T>
      * @param <T> the return type
      * @return The field's value or {@code null}.
      * @throws java.util.NoSuchElementException if the database returned no result at all.
      */
@@ -26,7  26,7 @@ public interface QueryResult {
      * {@code QueryResult#get(Field<T>)} method.
      * @param index the index of the column's value you wish to get.
      * @param type the expected type of that column.
-     * @param <T>
      * @param <T> the return type
      * @return The field's value or {@code null}.
      * @throws ClassCastException If the column is mapped by a jOOQ-{@code Converter}, the underlying implementation
      * might throw a {@code ClassCastException} because the non-jdbc drivers are not aware of converters. For correct
@@ -40,7  40,7 @@ public interface QueryResult {
      * {@code QueryResult#get(Field<T>)} method.
      * @param columnName the name of the column you wish to get.
      * @param type the expected type of that column.
-     * @param <T>
      * @param <T> the return type
      * @return The field's value or {@code null}.
      * @throws ClassCastException If the column is mapped by a jOOQ-{@code Converter}, the underlying implementation
      * might throw a {@code ClassCastException} because the non-jdbc drivers are not aware of converters. For correct
@@ -50,7  50,7 @@ public interface QueryResult {
     public <T> T get(String columnName, Class<T> type);
 
     /**
-     * @param <T>
      * @param <T> the implementation type
      * @return the driver's implementation of this result, e.g. {@code org.jooq.Result}.
      */
     public <T> T unwrap();

diff --git a/...jooq-shared/src/main/java/io/github/jklingsporn/vertx/jooq/shared/internal/VertxPojo.java b/...jooq-shared/src/main/java/io/github/jklingsporn/vertx/jooq/shared/internal/VertxPojo.java
@@ -25,9  25,9 @@ public interface VertxPojo {
     /**
      * For internal purposes only.<br>
      * Function to safely set a value inside a POJO. Helps users to find bugs if they accidentally put a value into
-     * a <{@code JsonObject} with a wrong type.
      * a {@code JsonObject} with a wrong type.
      * @param pojoSetter the setter of this POJO's property
-     * @param jsonGetter the function to obtain the value from the <{@code JsonObject}
      * @param jsonGetter the function to obtain the value from the {@code JsonObject}
      * @param fieldName the name of the POJO / JSON-property
      * @param expectedFieldType the type of the property/field
      * @param <T> the value type

diff --git a/...rc/main/java/io/github/jklingsporn/vertx/jooq/shared/internal/jdbc/JDBCQueryExecutor.java b/...rc/main/java/io/github/jklingsporn/vertx/jooq/shared/internal/jdbc/JDBCQueryExecutor.java
@@ -12,8  12,8 @@ public interface JDBCQueryExecutor<T> {
 
     /**
      * Executes any <code>DSLContext</code>-aware function using <code>Vertx#executeBlocking</code>.
-     * @param function
-     * @param <X>
      * @param function the function to be executed
      * @param <X> the type returned by the function
      * @return the result of this operation.
      */
     public <X> T executeAny(Function<DSLContext, X> function);