Merge pull request #635 from hazendaz/master

[javadocs] Cleanup existing javadocs along with proper ordering

Author: emacarron

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

@@ -24,8 +24,8 @@
 /**
  * The maker annotation that invoke a flush statements via Mapper interface.
  *
- * @author Kazuki Shimizu
  * @since 3.3.0
+ * @author Kazuki Shimizu
  */
 @Documented
 @Retention(RetentionPolicy.RUNTIME)

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

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2009-2015 the original author or authors.
+ *    Copyright 2009-2016 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,8 +28,7 @@
  * attributes = (',' attribute)*
  * attribute = name '=' value
  * </pre>
- */
-/**
+ *
  * @author Frank D. Martinez [mnesarco]
  */
 public class ParameterExpression extends HashMap<String, String> {

src/main/java/org/apache/ibatis/executor/BaseExecutor.java

@@ -293,9 +293,9 @@ protected void closeStatement(Statement statement) {
   /**
    * Apply a transaction timeout.
    * @param statement a current statement
-   * @exception SQLException if a database access error occurs, this method is called on a closed <code>Statement</code>
-   * @see StatementUtil#applyTransactionTimeout(Statement, Integer, Integer)
+   * @throws SQLException if a database access error occurs, this method is called on a closed <code>Statement</code>
    * @since 3.4.0
+   * @see StatementUtil#applyTransactionTimeout(Statement, Integer, Integer)
    */
   protected void applyTransactionTimeout(Statement statement) throws SQLException {
     StatementUtil.applyTransactionTimeout(statement, statement.getQueryTimeout(), transaction.getTimeout());

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

@@ -21,8 +21,8 @@
 /**
  * Utility for {@link java.sql.Statement}.
  *
- * @author Kazuki Shimizu
  * @since 3.4.0
+ * @author Kazuki Shimizu
  */
 public class StatementUtil {
 
@@ -38,7 +38,7 @@ private StatementUtil() {
    * @param statement a target statement
    * @param queryTimeout a query timeout
    * @param transactionTimeout a transaction timeout
-   * @exception SQLException if a database access error occurs, this method is called on a closed <code>Statement</code>
+   * @throws SQLException if a database access error occurs, this method is called on a closed <code>Statement</code>
    */
   public static void applyTransactionTimeout(Statement statement, Integer queryTimeout, Integer transactionTimeout) throws SQLException {
     if (transactionTimeout == null){

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

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2009-2015 the original author or authors.
+ *    Copyright 2009-2016 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.
@@ -29,23 +29,23 @@
  * arbitrary conditions. The two most common conditions are that a class implements/extends
  * another class, or that is it annotated with a specific annotation. However, through the use
  * of the {@link Test} class it is possible to search using arbitrary conditions.</p>
- * <p/>
+ *
  * <p>A ClassLoader is used to locate all locations (directories and jar files) in the class
  * path that contain classes within certain packages, and then to load those classes and
  * check them. By default the ClassLoader returned by
  * {@code Thread.currentThread().getContextClassLoader()} is used, but this can be overridden
  * by calling {@link #setClassLoader(ClassLoader)} prior to invoking any of the {@code find()}
  * methods.</p>
- * <p/>
+ *
  * <p>General searches are initiated by calling the
  * {@link #find(org.apache.ibatis.io.ResolverUtil.Test, String)} ()} method and supplying
  * a package name and a Test instance. This will cause the named package <b>and all sub-packages</b>
  * to be scanned for classes that meet the test. There are also utility methods for the common
  * use cases of scanning multiple packages for extensions of particular classes, or classes
  * annotated with a specific annotation.</p>
- * <p/>
+ *
  * <p>The standard usage pattern for the ResolverUtil class is as follows:</p>
- * <p/>
+ *
  * <pre>
  * ResolverUtil&lt;ActionBean&gt; resolver = new ResolverUtil&lt;ActionBean&gt;();
  * resolver.findImplementation(ActionBean.class, pkg1, pkg2);

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

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2009-2015 the original author or authors.
+ *    Copyright 2009-2016 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.
@@ -142,7 +142,7 @@ protected static Method getMethod(Class<?> clazz, String methodName, Class<?>...
    * @param parameters The parameters to pass to the method.
    * @return Whatever the method returns.
    * @throws IOException If I/O errors occur
-   * @throws StripesRuntimeException If anything else goes wrong
+   * @throws RuntimeException If anything else goes wrong
    */
   @SuppressWarnings("unchecked")
   protected static <T> T invoke(Method method, Object object, Object... parameters)

src/main/java/org/apache/ibatis/jdbc/SelectBuilder.java

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2009-2015 the original author or authors.
+ *    Copyright 2009-2016 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.
@@ -16,7 +16,7 @@
 package org.apache.ibatis.jdbc;
 
 /**
- * @Deprecated Use the {@link SQL} Class
+ * @deprecated Use the {@link SQL} Class
  * 
  * @author Clinton Begin
  */

src/main/java/org/apache/ibatis/jdbc/SqlBuilder.java

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2009-2015 the original author or authors.
+ *    Copyright 2009-2016 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.
@@ -16,7 +16,7 @@
 package org.apache.ibatis.jdbc;
 
 /**
- * @Deprecated Use the {@link SQL} Class
+ * @deprecated Use the {@link SQL} Class
  *
  * @author Jeff Butler
  */

src/main/java/org/apache/ibatis/mapping/BoundSql.java

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2009-2015 the original author or authors.
+ *    Copyright 2009-2016 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.
@@ -30,8 +30,7 @@
  * the value from). 
  * </br>
  * Can also have additional parameters that are created by the dynamic language (for loops, bind...).
- */
-/**
+ *
  * @author Clinton Begin
  */
 public class BoundSql {

src/main/java/org/apache/ibatis/reflection/Reflector.java

@@ -38,11 +38,10 @@
 import org.apache.ibatis.reflection.invoker.SetFieldInvoker;
 import org.apache.ibatis.reflection.property.PropertyNamer;
 
-/*
+/**
  * This class represents a cached set of class definition information that
  * allows for easy mapping between property names and getter/setter methods.
- */
-/**
+ *
  * @author Clinton Begin
  */
 public class Reflector {