Skip to content

Commit 09f86b6

Browse files
committed
[javadocs] Cleanup existing javadocs along with proper ordering
1 parent 543d464 commit 09f86b6

37 files changed

+77
-92
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@
2424
/**
2525
* The maker annotation that invoke a flush statements via Mapper interface.
2626
*
27-
* @author Kazuki Shimizu
2827
* @since 3.3.0
28+
* @author Kazuki Shimizu
2929
*/
3030
@Documented
3131
@Retention(RetentionPolicy.RUNTIME)

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2009-2015 the original author or authors.
2+
* Copyright 2009-2016 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -28,8 +28,7 @@
2828
* attributes = (',' attribute)*
2929
* attribute = name '=' value
3030
* </pre>
31-
*/
32-
/**
31+
*
3332
* @author Frank D. Martinez [mnesarco]
3433
*/
3534
public class ParameterExpression extends HashMap<String, String> {

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -293,9 +293,9 @@ protected void closeStatement(Statement statement) {
293293
/**
294294
* Apply a transaction timeout.
295295
* @param statement a current statement
296-
* @exception SQLException if a database access error occurs, this method is called on a closed <code>Statement</code>
297-
* @see StatementUtil#applyTransactionTimeout(Statement, Integer, Integer)
296+
* @throws SQLException if a database access error occurs, this method is called on a closed <code>Statement</code>
298297
* @since 3.4.0
298+
* @see StatementUtil#applyTransactionTimeout(Statement, Integer, Integer)
299299
*/
300300
protected void applyTransactionTimeout(Statement statement) throws SQLException {
301301
StatementUtil.applyTransactionTimeout(statement, statement.getQueryTimeout(), transaction.getTimeout());

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@
2121
/**
2222
* Utility for {@link java.sql.Statement}.
2323
*
24-
* @author Kazuki Shimizu
2524
* @since 3.4.0
25+
* @author Kazuki Shimizu
2626
*/
2727
public class StatementUtil {
2828

@@ -38,7 +38,7 @@ private StatementUtil() {
3838
* @param statement a target statement
3939
* @param queryTimeout a query timeout
4040
* @param transactionTimeout a transaction timeout
41-
* @exception SQLException if a database access error occurs, this method is called on a closed <code>Statement</code>
41+
* @throws SQLException if a database access error occurs, this method is called on a closed <code>Statement</code>
4242
*/
4343
public static void applyTransactionTimeout(Statement statement, Integer queryTimeout, Integer transactionTimeout) throws SQLException {
4444
if (transactionTimeout == null){

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2009-2015 the original author or authors.
2+
* Copyright 2009-2016 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2009-2015 the original author or authors.
2+
* Copyright 2009-2016 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -29,23 +29,23 @@
2929
* arbitrary conditions. The two most common conditions are that a class implements/extends
3030
* another class, or that is it annotated with a specific annotation. However, through the use
3131
* of the {@link Test} class it is possible to search using arbitrary conditions.</p>
32-
* <p/>
32+
*
3333
* <p>A ClassLoader is used to locate all locations (directories and jar files) in the class
3434
* path that contain classes within certain packages, and then to load those classes and
3535
* check them. By default the ClassLoader returned by
3636
* {@code Thread.currentThread().getContextClassLoader()} is used, but this can be overridden
3737
* by calling {@link #setClassLoader(ClassLoader)} prior to invoking any of the {@code find()}
3838
* methods.</p>
39-
* <p/>
39+
*
4040
* <p>General searches are initiated by calling the
4141
* {@link #find(org.apache.ibatis.io.ResolverUtil.Test, String)} ()} method and supplying
4242
* a package name and a Test instance. This will cause the named package <b>and all sub-packages</b>
4343
* to be scanned for classes that meet the test. There are also utility methods for the common
4444
* use cases of scanning multiple packages for extensions of particular classes, or classes
4545
* annotated with a specific annotation.</p>
46-
* <p/>
46+
*
4747
* <p>The standard usage pattern for the ResolverUtil class is as follows:</p>
48-
* <p/>
48+
*
4949
* <pre>
5050
* ResolverUtil&lt;ActionBean&gt; resolver = new ResolverUtil&lt;ActionBean&gt;();
5151
* resolver.findImplementation(ActionBean.class, pkg1, pkg2);

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2009-2015 the original author or authors.
2+
* Copyright 2009-2016 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* 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<?>...
142142
* @param parameters The parameters to pass to the method.
143143
* @return Whatever the method returns.
144144
* @throws IOException If I/O errors occur
145-
* @throws StripesRuntimeException If anything else goes wrong
145+
* @throws RuntimeException If anything else goes wrong
146146
*/
147147
@SuppressWarnings("unchecked")
148148
protected static <T> T invoke(Method method, Object object, Object... parameters)

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2009-2015 the original author or authors.
2+
* Copyright 2009-2016 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -16,7 +16,7 @@
1616
package org.apache.ibatis.jdbc;
1717

1818
/**
19-
* @Deprecated Use the {@link SQL} Class
19+
* @deprecated Use the {@link SQL} Class
2020
*
2121
* @author Clinton Begin
2222
*/

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2009-2015 the original author or authors.
2+
* Copyright 2009-2016 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -16,7 +16,7 @@
1616
package org.apache.ibatis.jdbc;
1717

1818
/**
19-
* @Deprecated Use the {@link SQL} Class
19+
* @deprecated Use the {@link SQL} Class
2020
*
2121
* @author Jeff Butler
2222
*/

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2009-2015 the original author or authors.
2+
* Copyright 2009-2016 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -30,8 +30,7 @@
3030
* the value from).
3131
* </br>
3232
* Can also have additional parameters that are created by the dynamic language (for loops, bind...).
33-
*/
34-
/**
33+
*
3534
* @author Clinton Begin
3635
*/
3736
public class BoundSql {

0 commit comments

Comments
 (0)