alternatives to pr#3523

Author: guanchengang

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

@@ -30,14 +30,16 @@
  * <p>
  * <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") })
+ * <pre>
+ * <code>&#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") })
  * public interface UserMapper {
  *   // ...
  * }
- * }</pre>
+ * </code>
+ * </pre>
  *
  * @author Clinton Begin
  * @author Kazuki Shimizu

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

@@ -26,15 +26,16 @@
  * <p>
  * <b>How to use:</b>
  *
- * <pre>{@code
- * public interface UserMapper {
- *   @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") })
+ * <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") })
  *   &#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/Select.java

@@ -29,23 +29,25 @@
  * <ul>
  * <li>Simple:
  *
- * <pre>{@code
- * public interface UserMapper {
- *   @Select("SELECT id, name FROM users WHERE id = #{id}")
+ * <pre>
+ * <code>public interface UserMapper {
+ *   &#064;Select("SELECT id, name FROM users WHERE id = #{id}")
  *   User selectById(int id);
  * }
- * }</pre>
+ * </code>
+ * </pre>
  *
  * </li>
  * <li>Dynamic SQL:
  *
- * <pre>{@code
- * public interface UserMapper {
- *   @Select({ "<script>", "select * from users", "where name = #{name}",
- *       "<if test=\"age != null\"> age = #{age} </if>", "</script>" })
+ * <pre>
+ * <code>public interface UserMapper {
+ *   &#064;Select({ "&lt;script&gt;", "select * from users", "where name = #{name}",
+ *       "&lt;if test=\"age != null\"&gt; age = #{age} &lt;/if&gt;", "&lt;/script&gt;" })
  *   User select(@NotNull String name, @Nullable Integer age);
  * }
- * }</pre>
+ * </code>
+ * </pre>
  *
  * </li>
  * </ul>

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

@@ -30,15 +30,17 @@
  * <p>
  * <b>How to use:</b>
  *
- * <pre>{@code
- * public interface UserMapper {
+ * <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;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/plugin/Intercepts.java

@@ -26,8 +26,8 @@
  * <p>
  * <b>How to use:</b>
  *
- * <pre>{@code
- * @Intercepts({ &#064;Signature(type = Executor.class, method = "update", args = { MappedStatement.class, Object.class }) })
+ * <pre>
+ * <code>&#064;Intercepts({ &#064;Signature(type = Executor.class, method = "update", args = { MappedStatement.class, Object.class }) })
  * public class ExamplePlugin implements Interceptor {
  *   &#064;Override
  *   public Object intercept(Invocation invocation) throws Throwable {
@@ -37,7 +37,8 @@
  *     return returnObject;
  *   }
  * }
- * }</pre>
+ * </code>
+ * </pre>
  *
  * @author Clinton Begin
  */

src/main/java/org/apache/ibatis/type/SimpleTypeRegistry.java

@@ -48,7 +48,7 @@ private SimpleTypeRegistry() {
     // Prevent Instantiation
   }
 
-  /*
+  /**
    * Tells us if the class passed in is a known common type
    * @param clazz The class to check
    * @return True if the class is known

src/test/java/org/apache/ibatis/io/ExternalResourcesTest.java

@@ -39,7 +39,7 @@ class ExternalResourcesTest {
   private File badFile;
   private File tempFile;
 
-  /*
+  /**
    * @throws java.lang.Exception
    */
   @BeforeEach

src/test/java/org/apache/ibatis/submitted/dynsql/Parameter.java

@@ -17,7 +17,7 @@
 
 import java.util.List;
 
-/*
+/**
  * @author Jeff Butler
  */
 public class Parameter {

src/test/java/org/apache/ibatis/submitted/dynsql2/Parameter.java

@@ -17,7 +17,7 @@
 
 import java.util.List;
 
-/*
+/**
  * @author Jeff Butler
  */
 public class Parameter {

src/test/java/org/apache/ibatis/submitted/extends_with_constructor/NpeExtendsTest.java

@@ -33,7 +33,7 @@
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
 
-/*
+/**
  * Test for NPE when using extends.
  *
  * @author poitrac