Fix javadoc errors and warnings

Author: kazuki43zoo

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

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2010-2017 the original author or authors.
+ *    Copyright 2010-2018 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.
@@ -125,7 +125,7 @@ public class SqlSessionFactoryBean implements FactoryBean<SqlSessionFactory>, In
    * Sets the ObjectFactory.
    *
    * @since 1.1.2
-   * @param objectFactory
+   * @param objectFactory a custom ObjectFactory
    */
   public void setObjectFactory(ObjectFactory objectFactory) {
     this.objectFactory = objectFactory;
@@ -135,7 +135,7 @@ public void setObjectFactory(ObjectFactory objectFactory) {
    * Sets the ObjectWrapperFactory.
    *
    * @since 1.1.2
-   * @param objectWrapperFactory
+   * @param objectWrapperFactory a specified ObjectWrapperFactory
    */
   public void setObjectWrapperFactory(ObjectWrapperFactory objectWrapperFactory) {
     this.objectWrapperFactory = objectWrapperFactory;
@@ -145,7 +145,7 @@ public void setObjectWrapperFactory(ObjectWrapperFactory objectWrapperFactory) {
    * Gets the DatabaseIdProvider
    *
    * @since 1.1.0
-   * @return
+   * @return a specified DatabaseIdProvider
    */
   public DatabaseIdProvider getDatabaseIdProvider() {
     return databaseIdProvider;
@@ -156,24 +156,40 @@ public DatabaseIdProvider getDatabaseIdProvider() {
    * As of version 1.2.2 this variable is not initialized by default.
    *
    * @since 1.1.0
-   * @param databaseIdProvider
+   * @param databaseIdProvider a DatabaseIdProvider
    */
   public void setDatabaseIdProvider(DatabaseIdProvider databaseIdProvider) {
     this.databaseIdProvider = databaseIdProvider;
   }
 
+  /**
+   * Gets the VFS.
+   * @return a specified VFS
+   */
   public Class<? extends VFS> getVfs() {
     return this.vfs;
   }
 
+  /**
+   * Sets the VFS.
+   * @param vfs a VFS
+   */
   public void setVfs(Class<? extends VFS> vfs) {
     this.vfs = vfs;
   }
 
+  /**
+   * Gets the Cache.
+   * @return a specified Cache
+   */
   public Cache getCache() {
     return this.cache;
   }
 
+  /**
+   * Sets the Cache.
+   * @param cache a Cache
+   */
   public void setCache(Cache cache) {
     this.cache = cache;
   }
@@ -265,6 +281,8 @@ public void setFailFast(boolean failFast) {
   /**
    * Set the location of the MyBatis {@code SqlSessionFactory} config file. A typical value is
    * "WEB-INF/mybatis-configuration.xml".
+   *
+   * @param configLocation a location the MyBatis config file
    */
   public void setConfigLocation(Resource configLocation) {
     this.configLocation = configLocation;
@@ -286,6 +304,8 @@ public void setConfiguration(Configuration configuration) {
    * This is an alternative to specifying "&lt;sqlmapper&gt;" entries in an MyBatis config file.
    * This property being based on Spring's resource abstraction also allows for specifying
    * resource patterns here: e.g. "classpath*:sqlmap/*-mapper.xml".
+   *
+   * @param mapperLocations location of MyBatis mapper files
    */
   public void setMapperLocations(Resource[] mapperLocations) {
     this.mapperLocations = mapperLocations;
@@ -295,6 +315,8 @@ public void setMapperLocations(Resource[] mapperLocations) {
    * Set optional properties to be passed into the SqlSession configuration, as alternative to a
    * {@code &lt;properties&gt;} tag in the configuration xml file. This will be used to
    * resolve placeholders in the config file.
+   *
+   * @param  sqlSessionFactoryProperties optional properties for the SqlSessionFactory
    */
   public void setConfigurationProperties(Properties sqlSessionFactoryProperties) {
     this.configurationProperties = sqlSessionFactoryProperties;
@@ -314,6 +336,8 @@ public void setConfigurationProperties(Properties sqlSessionFactoryProperties) {
    * underlying target {@code DataSource}. If there's nevertheless a {@code TransactionAwareDataSourceProxy}
    * passed in, it will be unwrapped to extract its target {@code DataSource}.
    *
+   * @param dataSource a JDBC {@code DataSource}
+   *
    */
   public void setDataSource(DataSource dataSource) {
     if (dataSource instanceof TransactionAwareDataSourceProxy) {
@@ -333,6 +357,8 @@ public void setDataSource(DataSource dataSource) {
    * This is mainly meant for testing so that mock SqlSessionFactory classes can be injected. By
    * default, {@code SqlSessionFactoryBuilder} creates {@code DefaultSqlSessionFactory} instances.
    *
+   * @param sqlSessionFactoryBuilder a SqlSessionFactoryBuilder
+   *
    */
   public void setSqlSessionFactoryBuilder(SqlSessionFactoryBuilder sqlSessionFactoryBuilder) {
     this.sqlSessionFactoryBuilder = sqlSessionFactoryBuilder;

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

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2010-2016 the original author or authors.
+ *    Copyright 2010-2018 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.
@@ -44,6 +44,7 @@ public final class SqlSessionHolder extends ResourceHolderSupport {
    *
    * @param sqlSession the {@code SqlSession} has to be hold.
    * @param executorType the {@code ExecutorType} has to be hold.
+   * @param exceptionTranslator the {@code PersistenceExceptionTranslator} has to be hold.
    */
   public SqlSessionHolder(SqlSession sqlSession,
       ExecutorType executorType,

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

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2010-2017 the original author or authors.
+ *    Copyright 2010-2018 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.
@@ -88,7 +88,7 @@ public class SqlSessionTemplate implements SqlSession, DisposableBean {
    * Constructs a Spring managed SqlSession with the {@code SqlSessionFactory}
    * provided as an argument.
    *
-   * @param sqlSessionFactory
+   * @param sqlSessionFactory a factory of SqlSession
    */
   public SqlSessionTemplate(SqlSessionFactory sqlSessionFactory) {
     this(sqlSessionFactory, sqlSessionFactory.getConfiguration().getDefaultExecutorType());
@@ -100,8 +100,8 @@ public SqlSessionTemplate(SqlSessionFactory sqlSessionFactory) {
    * {@code ExecutorType} cannot be changed once the {@code SqlSessionTemplate}
    * is constructed.
    *
-   * @param sqlSessionFactory
-   * @param executorType
+   * @param sqlSessionFactory a factory of SqlSession
+   * @param executorType an executor type on session
    */
   public SqlSessionTemplate(SqlSessionFactory sqlSessionFactory, ExecutorType executorType) {
     this(sqlSessionFactory, executorType,
@@ -119,9 +119,9 @@ public SqlSessionTemplate(SqlSessionFactory sqlSessionFactory, ExecutorType exec
    * exception translation will be done and MyBatis exceptions will be
    * thrown
    *
-   * @param sqlSessionFactory
-   * @param executorType
-   * @param exceptionTranslator
+   * @param sqlSessionFactory a factory of SqlSession
+   * @param executorType an executor type on session
+   * @param exceptionTranslator a translator of exception
    */
   public SqlSessionTemplate(SqlSessionFactory sqlSessionFactory, ExecutorType executorType,
       PersistenceExceptionTranslator exceptionTranslator) {
@@ -408,8 +408,8 @@ public List<BatchResult> flushStatements() {
   * The implementation of {@link DisposableBean} forces spring context to use {@link DisposableBean#destroy()} method instead of {@link SqlSessionTemplate#close()} to shutdown gently.
   *
   * @see SqlSessionTemplate#close()
-  * @see org.springframework.beans.factory.support.DisposableBeanAdapter#inferDestroyMethodIfNecessary
-  * @see org.springframework.beans.factory.support.DisposableBeanAdapter#CLOSE_METHOD_NAME
+  * @see "org.springframework.beans.factory.support.DisposableBeanAdapter#inferDestroyMethodIfNecessary(Object, RootBeanDefinition)"
+  * @see "org.springframework.beans.factory.support.DisposableBeanAdapter#CLOSE_METHOD_NAME"
   */
   @Override
   public void destroy() throws Exception {

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

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2010-2017 the original author or authors.
+ *    Copyright 2010-2018 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.
@@ -77,6 +77,7 @@ public static SqlSession getSqlSession(SqlSessionFactory sessionFactory) {
    * @param sessionFactory a MyBatis {@code SqlSessionFactory} to create new sessions
    * @param executorType The executor type of the SqlSession to create
    * @param exceptionTranslator Optional. Translates SqlSession.commit() exceptions to Spring exceptions.
+   * @return an SqlSession managed by Spring Transaction Manager
    * @throws TransientDataAccessResourceException if a transaction is active and the
    *             {@code SqlSessionFactory} is not using a {@code SpringManagedTransactionFactory}
    * @see SpringManagedTransactionFactory
@@ -162,8 +163,8 @@ private static SqlSession sessionHolder(ExecutorType executorType, SqlSessionHol
    * If it is not, it closes it, otherwise it just updates the reference counter and
    * lets Spring call the close callback when the managed transaction ends
    *
-   * @param session
-   * @param sessionFactory
+   * @param session a target SqlSession
+   * @param sessionFactory a factory of SqlSession
    */
   public static void closeSqlSession(SqlSession session, SqlSessionFactory sessionFactory) {
     notNull(session, NO_SQL_SESSION_SPECIFIED);

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

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2010-2017 the original author or authors.
+ *    Copyright 2010-2018 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.
@@ -77,15 +77,18 @@
   /**
    * Alias for the {@link #basePackages()} attribute. Allows for more concise
    * annotation declarations e.g.:
-   * {@code @EnableMyBatisMapperScanner("org.my.pkg")} instead of {@code
-   * @EnableMyBatisMapperScanner(basePackages= "org.my.pkg"})}.
+   * {@code @MapperScan("org.my.pkg")} instead of {@code @MapperScan(basePackages = "org.my.pkg"})}.
+   *
+   * @return base package names
    */
   String[] value() default {};
 
   /**
    * Base packages to scan for MyBatis interfaces. Note that only interfaces
    * with at least one method will be registered; concrete classes will be
    * ignored.
+   *
+   * @return base package names for scanning mapper interface
    */
   String[] basePackages() default {};
 
@@ -94,12 +97,16 @@
    * to scan for annotated components. The package of each class specified will be scanned.
    * <p>Consider creating a special no-op marker class or interface in each package
    * that serves no purpose other than being referenced by this attribute.
+   *
+   * @return classes that indicate base package for scanning mapper interface
    */
   Class<?>[] basePackageClasses() default {};
 
   /**
    * The {@link BeanNameGenerator} class to be used for naming detected components
    * within the Spring container.
+   *
+   * @return the class of {@link BeanNameGenerator}
    */
   Class<? extends BeanNameGenerator> nameGenerator() default BeanNameGenerator.class;
 
@@ -110,6 +117,8 @@
    * the specified annotation.
    * <p>
    * Note this can be combined with markerInterface.
+   *
+   * @return the annotation that the scanner will search for
    */
   Class<? extends Annotation> annotationClass() default Annotation.class;
 
@@ -120,26 +129,33 @@
    * the specified interface class as a parent.
    * <p>
    * Note this can be combined with annotationClass.
+   *
+   * @return the parent that the scanner will search for
    */
   Class<?> markerInterface() default Class.class;
 
   /**
    * Specifies which {@code SqlSessionTemplate} to use in the case that there is
    * more than one in the spring context. Usually this is only needed when you
    * have more than one datasource.
+   *
+   * @return the bean name of {@code SqlSessionTemplate}
    */
   String sqlSessionTemplateRef() default "";
 
   /**
    * Specifies which {@code SqlSessionFactory} to use in the case that there is
    * more than one in the spring context. Usually this is only needed when you
    * have more than one datasource.
+   *
+   * @return the bean name of {@code SqlSessionFactory}
    */
   String sqlSessionFactoryRef() default "";
 
   /**
    * Specifies a custom MapperFactoryBean to return a mybatis proxy as spring bean.
    *
+   * @return the class of {@code MapperFactoryBean}
    */
   Class<? extends MapperFactoryBean> factoryBean() default MapperFactoryBean.class;
 

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

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2010-2017 the original author or authors.
+ *    Copyright 2010-2018 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.
@@ -36,16 +36,16 @@
 /**
  * {@code ItemWriter} that uses the batching features from
  * {@code SqlSessionTemplate} to execute a batch of statements for all items
- * provided.<br/>
- *
- * Provided to facilitate the migration from Spring-Batch iBATIS 2 writers to MyBatis 3<br/>
- *
+ * provided.
+ * <p>
+ * Provided to facilitate the migration from Spring-Batch iBATIS 2 writers to MyBatis 3.
+ * <p>
  * The user must provide a MyBatis statement id that points to the SQL statement defined
- * in the MyBatis.<br/>
- *
+ * in the MyBatis.
+ * <p>
  * It is expected that {@link #write(List)} is called inside a transaction. If it is not
- * each statement call will be autocommitted and flushStatements will return no results.<br/>
- *
+ * each statement call will be autocommitted and flushStatements will return no results.
+ * <p>
  * The writer is thread safe after its properties are set (normal singleton
  * behavior), so it can be used to write in multiple concurrent transactions.
  *

src/main/java/org/mybatis/spring/mapper/MapperFactoryBean.java

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2010-2017 the original author or authors.
+ *    Copyright 2010-2018 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.
@@ -134,13 +134,13 @@ public Class<T> getMapperInterface() {
   /**
    * If addToConfig is false the mapper will not be added to MyBatis. This means
    * it must have been included in mybatis-config.xml.
-   * <p/>
+   * <p>
    * If it is true, the mapper will be added to MyBatis in the case it is not already
    * registered.
-   * <p/>
+   * <p>
    * By default addToConfig is true.
    *
-   * @param addToConfig
+   * @param addToConfig a flag that whether add mapper to MyBatis or not
    */
   public void setAddToConfig(boolean addToConfig) {
     this.addToConfig = addToConfig;