Merge pull request #1165 from hazendaz/master

Resolve source side javadoc concerns

Author: hazendaz

src/main/java/org/mybatis/logging/Logger.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2010-2022 the original author or authors.
+ * Copyright 2010-2025 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.
@@ -26,30 +26,69 @@
  */
 public class Logger {
 
+  /** The log. */
   private final Log log;
 
+  /**
+   * Instantiates a new logger.
+   *
+   * @param log
+   *          the log
+   */
   Logger(Log log) {
     this.log = log;
   }
 
+  /**
+   * Error.
+   *
+   * @param s
+   *          the s
+   * @param e
+   *          the e
+   */
   public void error(Supplier<String> s, Throwable e) {
     log.error(s.get(), e);
   }
 
+  /**
+   * Error.
+   *
+   * @param s
+   *          the s
+   */
   public void error(Supplier<String> s) {
     log.error(s.get());
   }
 
+  /**
+   * Warn.
+   *
+   * @param s
+   *          the s
+   */
   public void warn(Supplier<String> s) {
     log.warn(s.get());
   }
 
+  /**
+   * Debug.
+   *
+   * @param s
+   *          the s
+   */
   public void debug(Supplier<String> s) {
     if (log.isDebugEnabled()) {
       log.debug(s.get());
     }
   }
 
+  /**
+   * Trace.
+   *
+   * @param s
+   *          the s
+   */
   public void trace(Supplier<String> s) {
     if (log.isTraceEnabled()) {
       log.trace(s.get());

src/main/java/org/mybatis/logging/LoggerFactory.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2010-2022 the original author or authors.
+ * Copyright 2010-2025 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.
@@ -24,14 +24,33 @@
  */
 public class LoggerFactory {
 
+  /**
+   * Instantiates a new logger factory.
+   */
   private LoggerFactory() {
     // NOP
   }
 
+  /**
+   * Gets the logger.
+   *
+   * @param aClass
+   *          the a class
+   *
+   * @return the logger
+   */
   public static Logger getLogger(Class<?> aClass) {
     return new Logger(LogFactory.getLog(aClass));
   }
 
+  /**
+   * Gets the logger.
+   *
+   * @param logger
+   *          the logger
+   *
+   * @return the logger
+   */
   public static Logger getLogger(String logger) {
     return new Logger(LogFactory.getLog(logger));
   }

src/main/java/org/mybatis/spring/MyBatisSystemException.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2010-2023 the original author or authors.
+ * Copyright 2010-2025 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.
@@ -31,11 +31,27 @@ public class MyBatisSystemException extends UncategorizedDataAccessException {
 
   private static final long serialVersionUID = -5284728621670758939L;
 
+  /**
+   * Instantiates a new my batis system exception.
+   *
+   * @param cause
+   *          the cause
+   *
+   * @deprecated as of 3.0.4, use {@link #MyBatisSystemException(String, Throwable)} instead
+   */
   @Deprecated(since = "3.0.4", forRemoval = true)
   public MyBatisSystemException(Throwable cause) {
     this(cause.getMessage(), cause);
   }
 
+  /**
+   * Instantiates a new my batis system exception.
+   *
+   * @param msg
+   *          the msg
+   * @param cause
+   *          the cause
+   */
   public MyBatisSystemException(String msg, Throwable cause) {
     super(msg, cause);
   }

src/main/java/org/mybatis/spring/SqlSessionHolder.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2010-2022 the original author or authors.
+ * Copyright 2010-2025 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.
@@ -59,14 +59,29 @@ public SqlSessionHolder(SqlSession sqlSession, ExecutorType executorType,
     this.exceptionTranslator = exceptionTranslator;
   }
 
+  /**
+   * Gets the sql session.
+   *
+   * @return the sql session
+   */
   public SqlSession getSqlSession() {
     return sqlSession;
   }
 
+  /**
+   * Gets the executor type.
+   *
+   * @return the executor type
+   */
   public ExecutorType getExecutorType() {
     return executorType;
   }
 
+  /**
+   * Gets the persistence exception translator.
+   *
+   * @return the persistence exception translator
+   */
   public PersistenceExceptionTranslator getPersistenceExceptionTranslator() {
     return exceptionTranslator;
   }

src/main/java/org/mybatis/spring/SqlSessionTemplate.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2010-2024 the original author or authors.
+ * Copyright 2010-2025 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.
@@ -132,14 +132,29 @@ public SqlSessionTemplate(SqlSessionFactory sqlSessionFactory, ExecutorType exec
         new Class[] { SqlSession.class }, new SqlSessionInterceptor());
   }
 
+  /**
+   * Gets the sql session factory.
+   *
+   * @return the sql session factory
+   */
   public SqlSessionFactory getSqlSessionFactory() {
     return this.sqlSessionFactory;
   }
 
+  /**
+   * Gets the executor type.
+   *
+   * @return the executor type
+   */
   public ExecutorType getExecutorType() {
     return this.executorType;
   }
 
+  /**
+   * Gets the persistence exception translator.
+   *
+   * @return the persistence exception translator
+   */
   public PersistenceExceptionTranslator getPersistenceExceptionTranslator() {
     return this.exceptionTranslator;
   }

src/main/java/org/mybatis/spring/annotation/MapperScan.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2010-2024 the original author or authors.
+ * Copyright 2010-2025 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.
@@ -40,7 +40,6 @@
  * the class that declares this annotation.
  * <p>
  * Configuration example:
- * </p>
  *
  * <pre class="code">
  * &#064;Configuration
@@ -168,7 +167,6 @@
    * Whether enable lazy initialization of mapper bean.
    * <p>
    * Default is {@code false}.
-   * </p>
    *
    * @return set {@code true} to enable lazy initialization
    *
@@ -180,7 +178,6 @@
    * Specifies the default scope of scanned mappers.
    * <p>
    * Default is {@code ""} (equiv to singleton).
-   * </p>
    *
    * @return the default scope
    */

src/main/java/org/mybatis/spring/annotation/MapperScans.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2010-2022 the original author or authors.
+ * Copyright 2010-2025 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.
@@ -41,5 +41,11 @@
 @Documented
 @Import(MapperScannerRegistrar.RepeatingRegistrar.class)
 public @interface MapperScans {
+
+  /**
+   * Value.
+   *
+   * @return the mapper scan[]
+   */
   MapperScan[] value();
 }

src/main/java/org/mybatis/spring/batch/MyBatisBatchItemWriter.java

@@ -47,6 +47,9 @@
  *
  * @author Eduardo Macarron
  *
+ * @param <T>
+ *          the generic type
+ *
  * @since 1.1.0
  */
 public class MyBatisBatchItemWriter<T> implements ItemWriter<T>, InitializingBean {

src/main/java/org/mybatis/spring/batch/MyBatisCursorItemReader.java

@@ -32,7 +32,12 @@
 import org.springframework.beans.factory.InitializingBean;
 
 /**
+ * {@code ItemReader} that uses MyBatis Cursor to read data.
+ *
  * @author Guillaume Darmont / [email protected]
+ *
+ * @param <T>
+ *          the generic type
  */
 public class MyBatisCursorItemReader<T> extends AbstractItemCountingItemStreamItemReader<T>
     implements InitializingBean {
@@ -48,6 +53,9 @@ public class MyBatisCursorItemReader<T> extends AbstractItemCountingItemStreamIt
   private Cursor<T> cursor;
   private Iterator<T> cursorIterator;
 
+  /**
+   * Instantiates a new my batis cursor item reader.
+   */
   public MyBatisCursorItemReader() {
     setName(getShortName(MyBatisCursorItemReader.class));
   }

src/main/java/org/mybatis/spring/batch/MyBatisPagingItemReader.java

@@ -31,12 +31,16 @@
 import org.springframework.batch.infrastructure.item.database.AbstractPagingItemReader;
 
 /**
- * {@code org.springframework.batch.item.ItemReader} for reading database records using MyBatis in a paging fashion.
+ * {@code org.springframework.batch.infrastructure.item.ItemReader} for reading database records using MyBatis in a
+ * paging fashion.
  * <p>
  * Provided to facilitate the migration from Spring-Batch iBATIS 2 page item readers to MyBatis 3.
  *
  * @author Eduardo Macarron
  *
+ * @param <T>
+ *          the generic type
+ *
  * @since 1.1.0
  */
 public class MyBatisPagingItemReader<T> extends AbstractPagingItemReader<T> {
@@ -51,6 +55,9 @@ public class MyBatisPagingItemReader<T> extends AbstractPagingItemReader<T> {
 
   private Supplier<Map<String, Object>> parameterValuesSupplier;
 
+  /**
+   * Instantiates a new my batis paging item reader.
+   */
   public MyBatisPagingItemReader() {
     setName(getShortName(MyBatisPagingItemReader.class));
   }