Merge pull request #3368 from hazendaz/pom-cleanup

Cleanup javadoc issues

Author: hazendaz

src/main/java/org/apache/ibatis/annotations/CacheNamespace.java

@@ -28,18 +28,16 @@
 /**
  * The annotation that specify to use cache on namespace(e.g. mapper interface).
  * <p>
- * <b>How to use:</b> <code>
- * <pre>
- * &#064;CacheNamespace(implementation = CustomCache.class, properties = {
- *   &#064;Property(name = "host", value = "${mybatis.cache.host}"),
- *   &#064;Property(name = "port", value = "${mybatis.cache.port}"),
- *   &#064;Property(name = "name", value = "usersCache")
- * })
+ * <b>How to use:</b>
+ *
+ * <pre>{@code
+ * @CacheNamespace(implementation = CustomCache.class, properties = {
+ *     &#064;Property(name = "host", value = "${mybatis.cache.host}"),
+ *     &#064;Property(name = "port", value = "${mybatis.cache.port}"), &#064;Property(name = "name", value = "usersCache") })
  * public interface UserMapper {
  *   // ...
  * }
- * </pre>
- * </code>
+ * }</pre>
  *
  * @author Clinton Begin
  * @author Kazuki Shimizu

src/main/java/org/apache/ibatis/annotations/ConstructorArgs.java

@@ -24,19 +24,17 @@
 /**
  * The annotation that be grouping mapping definitions for constructor.
  * <p>
- * <b>How to use:</b> <code>
- * <pre>
+ * <b>How to use:</b>
+ *
+ * <pre>{@code
  * public interface UserMapper {
- *   &#064;ConstructorArgs({
- *     &#064;Arg(column = "id", javaType = int.class, id = true),
- *     &#064;Arg(column = "name", javaType = String.class),
- *     &#064;Arg(javaType = UserEmail.class, select = "selectUserEmailById", column = "id")
- *   })
+ *   @ConstructorArgs({ &#064;Arg(column = "id", javaType = int.class, id = true),
+ *       &#064;Arg(column = "name", javaType = String.class),
+ *       &#064;Arg(javaType = UserEmail.class, select = "selectUserEmailById", column = "id") })
  *   &#064;Select("SELECT id, name FROM users WHERE id = #{id}")
  *   User selectById(int id);
  * }
- * </pre>
- * </code>
+ * }</pre>
  *
  * @author Clinton Begin
  */

src/main/java/org/apache/ibatis/annotations/DeleteProvider.java

@@ -25,11 +25,12 @@
 /**
  * The annotation that specify a method that provide an SQL for deleting record(s).
  * <p>
- * <b>How to use:</b> <code>
- * <pre>
+ * <b>How to use:</b>
+ *
+ * <pre>{@code
  * public interface UserMapper {
  *
- *   &#064;DeleteProvider(type = SqlProvider.class, method = "deleteById")
+ *   @DeleteProvider(type = SqlProvider.class, method = "deleteById")
  *   boolean deleteById(int id);
  *
  *   public static class SqlProvider {
@@ -39,8 +40,7 @@
  *   }
  *
  * }
- * </pre>
- * </code>
+ * }</pre>
  *
  * @author Clinton Begin
  */
@@ -77,20 +77,15 @@
    * <p>
    * Since 3.5.1, this attribute can omit.
    * <p>
-   * If this attribute omit, the MyBatis will call a method that decide by following rules. <code>
-   *   <ul>
-   *     <li>
-   *       If class that specified the {@link #type()} attribute implements the
-   *       {@link org.apache.ibatis.builder.annotation.ProviderMethodResolver},
-   *       the MyBatis use a method that returned by it
-   *     </li>
-   *     <li>
-   *       If cannot resolve a method by {@link org.apache.ibatis.builder.annotation.ProviderMethodResolver}
-   *       (= not implement it or it was returned {@code null}), the MyBatis will search
-   *       and use a fallback method that named {@code provideSql} from specified type
-   *    </li>
-   *   </ul>
-   * </code>
+   * If this attribute omit, the MyBatis will call a method that decide by following rules.
+   * <ul>
+   * <li>If class that specified the {@link #type()} attribute implements the
+   * {@link org.apache.ibatis.builder.annotation.ProviderMethodResolver}, the MyBatis use a method that returned by it
+   * </li>
+   * <li>If cannot resolve a method by {@link org.apache.ibatis.builder.annotation.ProviderMethodResolver} (= not
+   * implement it or it was returned <code>null</code>), the MyBatis will search and use a fallback method that named
+   * <code>provideSql</code> from specified type</li>
+   * </ul>
    *
    * @return a method name of method for providing an SQL
    */

src/main/java/org/apache/ibatis/annotations/InsertProvider.java

@@ -25,11 +25,12 @@
 /**
  * The annotation that specify a method that provide an SQL for inserting record(s).
  * <p>
- * <b>How to use:</b> <code>
- * <pre>
+ * <b>How to use:</b>
+ *
+ * <pre>{@code
  * public interface UserMapper {
  *
- *   &#064;InsertProvider(type = SqlProvider.class, method = "insert")
+ *   @InsertProvider(type = SqlProvider.class, method = "insert")
  *   void insert(User user);
  *
  *   public static class SqlProvider {
@@ -39,8 +40,7 @@
  *   }
  *
  * }
- * </pre>
- * </code>
+ * }</pre>
  *
  * @author Clinton Begin
  */
@@ -77,20 +77,15 @@
    * <p>
    * Since 3.5.1, this attribute can omit.
    * <p>
-   * If this attribute omit, the MyBatis will call a method that decide by following rules. <code>
-   *   <ul>
-   *     <li>
-   *       If class that specified the {@link #type()} attribute implements the
-   *       {@link org.apache.ibatis.builder.annotation.ProviderMethodResolver},
-   *       the MyBatis use a method that returned by it
-   *     </li>
-   *     <li>
-   *       If cannot resolve a method by {@link org.apache.ibatis.builder.annotation.ProviderMethodResolver}
-   *       (= not implement it or it was returned {@code null}), the MyBatis will search
-   *       and use a fallback method that named {@code provideSql} from specified type
-   *     </li>
-   *   </ul>
-   * </code>
+   * If this attribute omit, the MyBatis will call a method that decide by following rules.
+   * <ul>
+   * <li>If class that specified the {@link #type()} attribute implements the
+   * {@link org.apache.ibatis.builder.annotation.ProviderMethodResolver}, the MyBatis use a method that returned by it
+   * </li>
+   * <li>If cannot resolve a method by {@link org.apache.ibatis.builder.annotation.ProviderMethodResolver} (= not
+   * implement it or it was returned <code>null</code>), the MyBatis will search and use a fallback method that named
+   * <code>provideSql</code> from specified type</li>
+   * </ul>
    *
    * @return a method name of method for providing an SQL
    */

src/main/java/org/apache/ibatis/annotations/Options.java

@@ -1,5 +1,5 @@
 /*
- *    Copyright 2009-2023 the original author or authors.
+ *    Copyright 2009-2024 the original author or authors.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -110,7 +110,6 @@ enum FlushCachePolicy {
    * Returns property names that holds a key value.
    * <p>
    * If you specify multiple property, please separate using comma(',').
-   * </p>
    *
    * @return property names that separate with comma(',')
    */
@@ -120,7 +119,6 @@ enum FlushCachePolicy {
    * Returns column names that retrieves a key value.
    * <p>
    * If you specify multiple column, please separate using comma(',').
-   * </p>
    *
    * @return column names that separate with comma(',')
    */
@@ -130,7 +128,6 @@ enum FlushCachePolicy {
    * Returns result set names.
    * <p>
    * If you specify multiple result set, please separate using comma(',').
-   * </p>
    *
    * @return result set names that separate with comma(',')
    */

src/main/java/org/apache/ibatis/annotations/Select.java

@@ -26,7 +26,6 @@
  * The annotation that specify an SQL for retrieving record(s).
  * <p>
  * <b>How to use:</b>
- * <p>
  * <ul>
  * <li>Simple:
  *

src/main/java/org/apache/ibatis/annotations/SelectKey.java

@@ -1,5 +1,5 @@
 /*
- *    Copyright 2009-2023 the original author or authors.
+ *    Copyright 2009-2024 the original author or authors.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -55,7 +55,6 @@
    * Returns property names that holds a key value.
    * <p>
    * If you specify multiple property, please separate using comma(',').
-   * </p>
    *
    * @return property names that separate with comma(',')
    */
@@ -65,7 +64,6 @@
    * Returns column names that retrieves a key value.
    * <p>
    * If you specify multiple column, please separate using comma(',').
-   * </p>
    *
    * @return column names that separate with comma(',')
    */

src/main/java/org/apache/ibatis/annotations/SelectProvider.java

@@ -25,11 +25,12 @@
 /**
  * The annotation that specify a method that provide an SQL for retrieving record(s).
  * <p>
- * <b>How to use:</b> <code>
- * <pre>
+ * <b>How to use:</b>
+ *
+ * <pre>{@code
  * public interface UserMapper {
  *
- *   &#064;SelectProvider(type = SqlProvider.class, method = "selectById")
+ *   @SelectProvider(type = SqlProvider.class, method = "selectById")
  *   User selectById(int id);
  *
  *   public static class SqlProvider {
@@ -39,8 +40,7 @@
  *   }
  *
  * }
- * </pre>
- * </code>
+ * }</pre>
  *
  * @author Clinton Begin
  */
@@ -77,20 +77,15 @@
    * <p>
    * Since 3.5.1, this attribute can omit.
    * <p>
-   * If this attribute omit, the MyBatis will call a method that decide by following rules. <code>
-   *   <ul>
-   *     <li>
-   *       If class that specified the {@link #type()} attribute implements the
-   *       {@link org.apache.ibatis.builder.annotation.ProviderMethodResolver},
-   *       the MyBatis use a method that returned by it.
-   *     </li>
-   *     <li>
-   *       If cannot resolve a method by {@link org.apache.ibatis.builder.annotation.ProviderMethodResolver}
-   *       (= not implement it or it was returned {@code null}), the MyBatis will search
-   *       and use a fallback method that named {@code provideSql} from specified type.
-   *     </li>
-   *   </ul>
-   * </code>
+   * If this attribute omit, the MyBatis will call a method that decide by following rules.
+   * <ul>
+   * <li>If class that specified the {@link #type()} attribute implements the
+   * {@link org.apache.ibatis.builder.annotation.ProviderMethodResolver}, the MyBatis use a method that returned by it.
+   * </li>
+   * <li>If cannot resolve a method by {@link org.apache.ibatis.builder.annotation.ProviderMethodResolver} (= not
+   * implement it or it was returned <code>null</code>), the MyBatis will search and use a fallback method that named
+   * <code>provideSql</code> from specified type.</li>
+   * </ul>
    *
    * @return a method name of method for providing an SQL
    */

src/main/java/org/apache/ibatis/annotations/TypeDiscriminator.java

@@ -28,23 +28,17 @@
 /**
  * The annotation that be grouping conditional mapping definitions.
  * <p>
- * <b>How to use:</b> <code>
- * <pre>
+ * <b>How to use:</b>
+ *
+ * <pre>{@code
  * public interface UserMapper {
  *   &#064;Select("SELECT id, name, type FROM users ORDER BY id")
- *   &#064;TypeDiscriminator(
- *     column = "type",
- *     javaType = String.class,
- *     cases = {
- *       &#064;Case(value = "1", type = PremiumUser.class),
- *       &#064;Case(value = "2", type = GeneralUser.class),
- *       &#064;Case(value = "3", type = TemporaryUser.class)
- *     }
- *   )
+ *   &#064;TypeDiscriminator(column = "type", javaType = String.class, cases = {
+ *       &#064;Case(value = "1", type = PremiumUser.class), &#064;Case(value = "2", type = GeneralUser.class),
+ *       &#064;Case(value = "3", type = TemporaryUser.class) })
  *   List&lt;User&gt; selectAll();
  * }
- * </pre>
- * </code>
+ * }</pre>
  *
  * @author Clinton Begin
  */

src/main/java/org/apache/ibatis/annotations/UpdateProvider.java

@@ -25,12 +25,12 @@
 /**
  * The annotation that specify a method that provide an SQL for updating record(s).
  * <p>
- * <b>How to use:</b> <code>
+ * <b>How to use:</b>
  *
- * <pre>
+ * <pre>{@code
  * public interface UserMapper {
  *
- *   &#064;UpdateProvider(type = SqlProvider.class, method = "update")
+ *   @UpdateProvider(type = SqlProvider.class, method = "update")
  *   boolean update(User user);
  *
  *   public static class SqlProvider {
@@ -40,9 +40,7 @@
  *   }
  *
  * }
- * </pre>
- *
- * <code>
+ * }</pre>
  *
  * @author Clinton Begin
  */
@@ -78,19 +76,15 @@
    * Specify a method for providing an SQL.
    * <p>
    * Since 3.5.1, this attribute can omit. If this attribute omit, the MyBatis will call a method that decide by
-   * following rules. <code>
-   *   <ul>
-   *     <li>
-   *       If class that specified the {@link #type()} attribute implements the
-   *       {@link org.apache.ibatis.builder.annotation.ProviderMethodResolver},
-   *       the MyBatis use a method that returned by it
-   *     </li>
-   *     <li>
-   *       If cannot resolve a method by {@link org.apache.ibatis.builder.annotation.ProviderMethodResolver}
-   *       (= not implement it or it was returned {@code null}), the MyBatis will search and use a fallback method
-   *       that named {@code provideSql} from specified type</li>
-   *   </ul>
-   * </code>
+   * following rules.
+   * <ul>
+   * <li>If class that specified the {@link #type()} attribute implements the
+   * {@link org.apache.ibatis.builder.annotation.ProviderMethodResolver}, the MyBatis use a method that returned by it
+   * </li>
+   * <li>If cannot resolve a method by {@link org.apache.ibatis.builder.annotation.ProviderMethodResolver} (= not
+   * implement it or it was returned <code>null</code>), the MyBatis will search and use a fallback method that named
+   * <code>provideSql</code> from specified type</li>
+   * </ul>
    *
    * @return a method name of method for providing an SQL
    */

src/main/java/org/apache/ibatis/builder/InitializingObject.java

@@ -1,5 +1,5 @@
 /*
- *    Copyright 2009-2023 the original author or authors.
+ *    Copyright 2009-2024 the original author or authors.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -28,7 +28,6 @@ public interface InitializingObject {
    * Initialize an instance.
    * <p>
    * This method will be invoked after it has set all properties.
-   * </p>
    *
    * @throws Exception
    *           in the event of misconfiguration (such as failure to set an essential property) or if initialization

src/main/java/org/apache/ibatis/executor/statement/StatementUtil.java

@@ -1,5 +1,5 @@
 /*
- *    Copyright 2009-2023 the original author or authors.
+ *    Copyright 2009-2024 the original author or authors.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -35,7 +35,6 @@ private StatementUtil() {
    * Apply a transaction timeout.
    * <p>
    * Update a query timeout to apply a transaction timeout.
-   * </p>
    *
    * @param statement
    *          a target statement