Merge pull request #1859 from hazendaz/checkstyle

[javadocs] Fix all warnings generated during site build

Author: hazendaz

src/main/java/org/apache/ibatis/binding/MapperRegistry.java

@@ -80,13 +80,22 @@ public <T> void addMapper(Class<T> type) {
   }
 
   /**
+   * Gets the mappers.
+   *
+   * @return the mappers
    * @since 3.2.2
    */
   public Collection<Class<?>> getMappers() {
     return Collections.unmodifiableCollection(knownMappers.keySet());
   }
 
   /**
+   * Adds the mappers.
+   *
+   * @param packageName
+   *            the package name
+   * @param superType
+   *            the super type
    * @since 3.2.2
    */
   public void addMappers(String packageName, Class<?> superType) {
@@ -99,6 +108,10 @@ public void addMappers(String packageName, Class<?> superType) {
   }
 
   /**
+   * Adds the mappers.
+   *
+   * @param packageName
+   *            the package name
    * @since 3.2.2
    */
   public void addMappers(String packageName) {

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

@@ -454,7 +454,33 @@ private Class<?> resolveParameterJavaType(Class<?> resultType, String property,
     return javaType;
   }
 
-  /** Backward compatibility signature. */
+  /**
+   *  Backward compatibility signature 'buildResultMapping'.
+   *
+   * @param resultType
+   *            the result type
+   * @param property
+   *            the property
+   * @param column
+   *            the column
+   * @param javaType
+   *            the java type
+   * @param jdbcType
+   *            the jdbc type
+   * @param nestedSelect
+   *            the nested select
+   * @param nestedResultMap
+   *            the nested result map
+   * @param notNullColumn
+   *            the not null column
+   * @param columnPrefix
+   *            the column prefix
+   * @param typeHandler
+   *            the type handler
+   * @param flags
+   *            the flags
+   * @return the result mapping
+   */
   public ResultMapping buildResultMapping(Class<?> resultType, String property, String column, Class<?> javaType,
       JdbcType jdbcType, String nestedSelect, String nestedResultMap, String notNullColumn, String columnPrefix,
       Class<? extends TypeHandler<?>> typeHandler, List<ResultFlag> flags) {
@@ -464,14 +490,61 @@ public ResultMapping buildResultMapping(Class<?> resultType, String property, St
   }
 
   /**
+   * Gets the language driver.
+   *
+   * @param langClass
+   *            the lang class
+   * @return the language driver
    * @deprecated Use {@link Configuration#getLanguageDriver(Class)}
    */
   @Deprecated
   public LanguageDriver getLanguageDriver(Class<? extends LanguageDriver> langClass) {
     return configuration.getLanguageDriver(langClass);
   }
 
-  /** Backward compatibility signature. */
+  /**
+   *  Backward compatibility signature 'addMappedStatement'.
+   *
+   * @param id
+   *            the id
+   * @param sqlSource
+   *            the sql source
+   * @param statementType
+   *            the statement type
+   * @param sqlCommandType
+   *            the sql command type
+   * @param fetchSize
+   *            the fetch size
+   * @param timeout
+   *            the timeout
+   * @param parameterMap
+   *            the parameter map
+   * @param parameterType
+   *            the parameter type
+   * @param resultMap
+   *            the result map
+   * @param resultType
+   *            the result type
+   * @param resultSetType
+   *            the result set type
+   * @param flushCache
+   *            the flush cache
+   * @param useCache
+   *            the use cache
+   * @param resultOrdered
+   *            the result ordered
+   * @param keyGenerator
+   *            the key generator
+   * @param keyProperty
+   *            the key property
+   * @param keyColumn
+   *            the key column
+   * @param databaseId
+   *            the database id
+   * @param lang
+   *            the lang
+   * @return the mapped statement
+   */
   public MappedStatement addMappedStatement(String id, SqlSource sqlSource, StatementType statementType,
       SqlCommandType sqlCommandType, Integer fetchSize, Integer timeout, String parameterMap, Class<?> parameterType,
       String resultMap, Class<?> resultType, ResultSetType resultSetType, boolean flushCache, boolean useCache,

src/main/java/org/apache/ibatis/builder/annotation/ProviderSqlSource.java

@@ -48,7 +48,12 @@ public class ProviderSqlSource implements SqlSource {
   /**
    * This constructor will remove at a future version.
    *
-   * @deprecated Since 3.5.3, Please use the {@link #ProviderSqlSource(Configuration, Annotation, Class, Method)} instead of this.
+   * @param configuration
+   *            the configuration
+   * @param provider
+   *            the provider
+   * @deprecated Since 3.5.3, Please use the {@link #ProviderSqlSource(Configuration, Annotation, Class, Method)}
+   *             instead of this.
    */
   @Deprecated
   public ProviderSqlSource(Configuration configuration, Object provider) {
@@ -58,6 +63,14 @@ public ProviderSqlSource(Configuration configuration, Object provider) {
   /**
    * This constructor will remove at a future version.
    *
+   * @param configuration
+   *            the configuration
+   * @param provider
+   *            the provider
+   * @param mapperType
+   *            the mapper type
+   * @param mapperMethod
+   *            the mapper method
    * @since 3.4.5
    * @deprecated Since 3.5.3, Please use the {@link #ProviderSqlSource(Configuration, Annotation, Class, Method)} instead of this.
    */
@@ -67,6 +80,16 @@ public ProviderSqlSource(Configuration configuration, Object provider, Class<?>
   }
 
   /**
+   * Instantiates a new provider sql source.
+   *
+   * @param configuration
+   *            the configuration
+   * @param provider
+   *            the provider
+   * @param mapperType
+   *            the mapper type
+   * @param mapperMethod
+   *            the mapper method
    * @since 3.5.3
    */
   public ProviderSqlSource(Configuration configuration, Annotation provider, Class<?> mapperType, Method mapperMethod) {

src/main/java/org/apache/ibatis/datasource/pooled/PooledDataSource.java

@@ -276,6 +276,9 @@ public Properties getDriverProperties() {
   }
 
   /**
+   * Gets the default network timeout.
+   *
+   * @return the default network timeout
    * @since 3.5.2
    */
   public Integer getDefaultNetworkTimeout() {

src/main/java/org/apache/ibatis/datasource/unpooled/UnpooledDataSource.java

@@ -185,6 +185,9 @@ public void setDefaultTransactionIsolationLevel(Integer defaultTransactionIsolat
   }
 
   /**
+   * Gets the default network timeout.
+   *
+   * @return the default network timeout
    * @since 3.5.2
    */
   public Integer getDefaultNetworkTimeout() {

src/main/java/org/apache/ibatis/executor/resultset/ResultSetWrapper.java

@@ -94,8 +94,10 @@ public JdbcType getJdbcType(String columnName) {
    * If not found it gets the column JDBC type and tries to get a handler for it.
    *
    * @param propertyType
+   *            the property type
    * @param columnName
-   * @return
+   *            the column name
+   * @return the type handler
    */
   public TypeHandler<?> getTypeHandler(Class<?> propertyType, String columnName) {
     TypeHandler<?> handler = null;

src/main/java/org/apache/ibatis/io/DefaultVFS.java

@@ -213,6 +213,7 @@ protected List<String> listResources(JarInputStream jar, String path) throws IOE
    * @param url The URL of the JAR entry.
    * @return The URL of the JAR file, if one is found. Null if not.
    * @throws MalformedURLException
+   *          the malformed URL exception
    */
   protected URL findJarForResource(URL url) throws MalformedURLException {
     if (log.isDebugEnabled()) {
@@ -294,7 +295,9 @@ protected URL findJarForResource(URL url) throws MalformedURLException {
    * Converts a Java package name to a path that can be looked up with a call to
    * {@link ClassLoader#getResources(String)}.
    *
-   * @param packageName The Java package name to convert to a path
+   * @param packageName
+   *          The Java package name to convert to a path
+   * @return the package path
    */
   protected String getPackagePath(String packageName) {
     return packageName == null ? null : packageName.replace('.', '/');
@@ -303,7 +306,9 @@ protected String getPackagePath(String packageName) {
   /**
    * Returns true if the resource located at the given URL is a JAR file.
    *
-   * @param url The URL of the resource to test.
+   * @param url
+   *          The URL of the resource to test.
+   * @return true, if is jar
    */
   protected boolean isJar(URL url) {
     return isJar(url, new byte[JAR_MAGIC.length]);
@@ -312,10 +317,12 @@ protected boolean isJar(URL url) {
   /**
    * Returns true if the resource located at the given URL is a JAR file.
    *
-   * @param url The URL of the resource to test.
-   * @param buffer A buffer into which the first few bytes of the resource are read. The buffer
-   *            must be at least the size of {@link #JAR_MAGIC}. (The same buffer may be reused
-   *            for multiple calls as an optimization.)
+   * @param url
+   *          The URL of the resource to test.
+   * @param buffer
+   *          A buffer into which the first few bytes of the resource are read. The buffer must be at least the size of
+   *          {@link #JAR_MAGIC}. (The same buffer may be reused for multiple calls as an optimization.)
+   * @return true, if is jar
    */
   protected boolean isJar(URL url, byte[] buffer) {
     InputStream is = null;

src/main/java/org/apache/ibatis/io/JBoss6VFS.java

@@ -111,7 +111,10 @@ protected static synchronized void initialize() {
    * Verifies that the provided object reference is null. If it is null, then this VFS is marked
    * as invalid for the current environment.
    *
-   * @param object The object reference to check for null.
+   * @param <T> the generic type
+   * @param object
+   *          The object reference to check for null.
+   * @return the t
    */
   protected static <T> T checkNotNull(T object) {
     if (object == null) {

src/main/java/org/apache/ibatis/io/ResolverUtil.java

@@ -55,9 +55,11 @@
  * </pre>
  *
  * @author Tim Fennell
+ * @param <T> the generic type
  */
 public class ResolverUtil<T> {
-  /*
+
+  /**
    * An instance of Log to use for logging in this class.
    */
   private static final Log log = LogFactory.getLog(ResolverUtil.class);
@@ -67,9 +69,13 @@ public class ResolverUtil<T> {
    * are to be included in the results produced by the ResolverUtil.
    */
   public interface Test {
+
     /**
      * Will be called repeatedly with candidate classes. Must return True if a class
      * is to be included in the results, false otherwise.
+     *
+     * @param type the type
+     * @return true, if successful
      */
     boolean matches(Class<?> type);
   }
@@ -79,9 +85,15 @@ public interface Test {
    * that this test will match the parent type itself if it is presented for matching.
    */
   public static class IsA implements Test {
+
+    /** The parent. */
     private Class<?> parent;
 
-    /** Constructs an IsA test using the supplied Class as the parent class/interface. */
+    /**
+     *  Constructs an IsA test using the supplied Class as the parent class/interface.
+     *
+     * @param parentType the parent type
+     */
     public IsA(Class<?> parentType) {
       this.parent = parentType;
     }
@@ -103,9 +115,15 @@ public String toString() {
    * is, then the test returns true, otherwise false.
    */
   public static class AnnotatedWith implements Test {
+
+    /** The annotation. */
     private Class<? extends Annotation> annotation;
 
-    /** Constructs an AnnotatedWith test for the specified annotation type. */
+    /**
+     *  Constructs an AnnotatedWith test for the specified annotation type.
+     *
+     * @param annotation the annotation
+     */
     public AnnotatedWith(Class<? extends Annotation> annotation) {
       this.annotation = annotation;
     }
@@ -167,8 +185,11 @@ public void setClassLoader(ClassLoader classloader) {
    * of a non-interface class, subclasses will be collected.  Accumulated classes can be
    * accessed by calling {@link #getClasses()}.
    *
-   * @param parent the class of interface to find subclasses or implementations of
-   * @param packageNames one or more package names to scan (including subpackages) for classes
+   * @param parent
+   *          the class of interface to find subclasses or implementations of
+   * @param packageNames
+   *          one or more package names to scan (including subpackages) for classes
+   * @return the resolver util
    */
   public ResolverUtil<T> findImplementations(Class<?> parent, String... packageNames) {
     if (packageNames == null) {
@@ -187,8 +208,11 @@ public ResolverUtil<T> findImplementations(Class<?> parent, String... packageNam
    * Attempts to discover classes that are annotated with the annotation. Accumulated
    * classes can be accessed by calling {@link #getClasses()}.
    *
-   * @param annotation the annotation that should be present on matching classes
-   * @param packageNames one or more package names to scan (including subpackages) for classes
+   * @param annotation
+   *          the annotation that should be present on matching classes
+   * @param packageNames
+   *          one or more package names to scan (including subpackages) for classes
+   * @return the resolver util
    */
   public ResolverUtil<T> findAnnotated(Class<? extends Annotation> annotation, String... packageNames) {
     if (packageNames == null) {
@@ -209,9 +233,11 @@ public ResolverUtil<T> findAnnotated(Class<? extends Annotation> annotation, Str
    * true the class is retained.  Accumulated classes can be fetched by calling
    * {@link #getClasses()}.
    *
-   * @param test an instance of {@link Test} that will be used to filter classes
-   * @param packageName the name of the package from which to start scanning for
-   *        classes, e.g. {@code net.sourceforge.stripes}
+   * @param test
+   *          an instance of {@link Test} that will be used to filter classes
+   * @param packageName
+   *          the name of the package from which to start scanning for classes, e.g. {@code net.sourceforge.stripes}
+   * @return the resolver util
    */
   public ResolverUtil<T> find(Test test, String packageName) {
     String path = getPackagePath(packageName);
@@ -234,7 +260,9 @@ public ResolverUtil<T> find(Test test, String packageName) {
    * Converts a Java package name to a path that can be looked up with a call to
    * {@link ClassLoader#getResources(String)}.
    *
-   * @param packageName The Java package name to convert to a path
+   * @param packageName
+   *          The Java package name to convert to a path
+   * @return the package path
    */
   protected String getPackagePath(String packageName) {
     return packageName == null ? null : packageName.replace('.', '/');