Add javadoc for annotations

Author: kazuki43zoo

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

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2009-2018 the original author or authors.
+ *    Copyright 2009-2019 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.
@@ -25,29 +25,76 @@
 import org.apache.ibatis.type.UnknownTypeHandler;
 
 /**
+ * The annotation that specify a mapping definition for the constructor argument.
+ *
  * @author Clinton Begin
  */
 @Documented
 @Retention(RetentionPolicy.RUNTIME)
 @Target({})
 public @interface Arg {
+
+  /**
+   * Returns whether id column or not.
+   *
+   * @return {@code true} if id column; {@code false} if otherwise
+   */
   boolean id() default false;
 
+  /**
+   * Return the column name(or column label) to map to this argument.
+   *
+   * @return the column name(or column label)
+   */
   String column() default "";
 
+  /**
+   * Return the java type for this argument.
+   *
+   * @return the java type
+   */
   Class<?> javaType() default void.class;
 
+  /**
+   * Return the jdbc type for column that map to this argument.
+   *
+   * @return the jdbc type
+   */
   JdbcType jdbcType() default JdbcType.UNDEFINED;
 
+  /**
+   * Returns the {@link TypeHandler} type for retrieving a column value from result set.
+   *
+   * @return the {@link TypeHandler} type
+   */
   Class<? extends TypeHandler> typeHandler() default UnknownTypeHandler.class;
 
+  /**
+   * Return the statement id for retrieving a object that map to this argument.
+   *
+   * @return the statement id
+   */
   String select() default "";
 
+  /**
+   * Returns the result map id for mapping to a object that map to this argument.
+   *
+   * @return the result map id
+   */
   String resultMap() default "";
 
+  /**
+   * Returns the parameter name for applying this mapping.
+   *
+   * @return the parameter name
+   * @since 3.4.3
+   */
   String name() default "";
 
   /**
+   * Returns the column prefix that use when applying {@link #resultMap()}.
+   *
+   * @return the column prefix
    * @since 3.5.0
    */
   String columnPrefix() default "";

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

@@ -26,27 +26,62 @@
 import org.apache.ibatis.cache.impl.PerpetualCache;
 
 /**
+ * The annotation that specify to use cache on namespace(e.g. mapper interface).
+ *
  * @author Clinton Begin
  * @author Kazuki Shimizu
  */
 @Documented
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.TYPE)
 public @interface CacheNamespace {
+
+  /**
+   * Returns the cache implementation type to use.
+   *
+   * @return the cache implementation type
+   */
   Class<? extends Cache> implementation() default PerpetualCache.class;
 
+  /**
+   * Returns the cache evicting implementation type to use.
+   *
+   * @return the cache evicting implementation type
+   */
   Class<? extends Cache> eviction() default LruCache.class;
 
+  /**
+   * Returns the flush interval.
+   *
+   * @return the flush interval
+   */
   long flushInterval() default 0;
 
+  /**
+   * Return the cache size.
+   *
+   * @return the cache size
+   */
   int size() default 1024;
 
+  /**
+   * Returns whether use read/write cache.
+   *
+   * @return {@code true} if use read/write cache; {@code false} if otherwise
+   */
   boolean readWrite() default true;
 
+  /**
+   * Returns whether block the cache at request time or not.
+   *
+   * @return {@code true} if block the cache; {@code false} if otherwise
+   */
   boolean blocking() default false;
 
   /**
-   * Property values for a implementation object.
+   * Returns property values for a implementation object.
+   *
+   * @return property values
    * @since 3.4.2
    */
   Property[] properties() default {};

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

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2009-2016 the original author or authors.
+ *    Copyright 2009-2019 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.
@@ -21,17 +21,41 @@
 import java.lang.annotation.Target;
 
 /**
+ * The annotation that conditional mapping definition for {@link TypeDiscriminator}.
+ *
  * @author Clinton Begin
  */
 @Documented
 @Retention(RetentionPolicy.RUNTIME)
 @Target({})
 public @interface Case {
+
+  /**
+   * Return the condition value to apply this mapping.
+   *
+   * @return the condition value
+   */
   String value();
 
+  /**
+   * Return the object type that create a object using this mapping.
+   *
+   * @return the object type
+   */
   Class<?> type();
 
+  /**
+   * Return mapping definitions for property.
+   *
+   * @return mapping definitions for property
+   */
   Result[] results() default {};
 
+  /**
+   * Return mapping definitions for constructor.
+   *
+   * @return mapping definitions for constructor
+   */
   Arg[] constructArgs() default {};
+
 }

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

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2009-2016 the original author or authors.
+ *    Copyright 2009-2019 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.
@@ -22,11 +22,18 @@
 import java.lang.annotation.Target;
 
 /**
+ * The annotation that be grouping mapping definitions for constructor.
+ *
  * @author Clinton Begin
  */
 @Documented
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.METHOD)
 public @interface ConstructorArgs {
+  /**
+   * Returns mapping definitions for constructor.
+   *
+   * @return mapping definitions
+   */
   Arg[] value() default {};
 }

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

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2009-2016 the original author or authors.
+ *    Copyright 2009-2019 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.
@@ -22,11 +22,18 @@
 import java.lang.annotation.Target;
 
 /**
+ * The annotation that specify an SQL for deleting record(s).
+ *
  * @author Clinton Begin
  */
 @Documented
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.METHOD)
 public @interface Delete {
+  /**
+   * Returns an SQL for deleting record(s).
+   *
+   * @return an SQL for deleting record(s)
+   */
   String[] value();
 }

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

@@ -22,6 +22,8 @@
 import java.lang.annotation.Target;
 
 /**
+ * The annotation that specify a method that provide an SQL for deleting record(s).
+ *
  * @author Clinton Begin
  */
 @Documented

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

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2009-2016 the original author or authors.
+ *    Copyright 2009-2019 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.
@@ -22,11 +22,18 @@
 import java.lang.annotation.Target;
 
 /**
+ * The annotation that specify an SQL for inserting record(s).
+ *
  * @author Clinton Begin
  */
 @Documented
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.METHOD)
 public @interface Insert {
+  /**
+   * Returns an SQL for inserting record(s).
+   *
+   * @return an SQL for inserting record(s)
+   */
   String[] value();
 }

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

@@ -22,6 +22,8 @@
 import java.lang.annotation.Target;
 
 /**
+ * The annotation that specify a method that provide an SQL for inserting record(s).
+ *
  * @author Clinton Begin
  */
 @Documented

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

@@ -24,11 +24,18 @@
 import org.apache.ibatis.scripting.LanguageDriver;
 
 /**
+ * The annotation that specify a {@link LanguageDriver} to use.
+ *
  * @author Clinton Begin
  */
 @Documented
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.METHOD)
 public @interface Lang {
+  /**
+   * Returns the {@link LanguageDriver} implementation type to use.
+   *
+   * @return the {@link LanguageDriver} implementation type
+   */
   Class<? extends LanguageDriver> value();
 }

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

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2009-2016 the original author or authors.
+ *    Copyright 2009-2019 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.
@@ -23,14 +23,26 @@
 import org.apache.ibatis.mapping.FetchType;
 
 /**
+ * The annotation that specify the nested statement for retrieving collections.
+ *
  * @author Clinton Begin
  */
 @Documented
 @Retention(RetentionPolicy.RUNTIME)
 @Target({})
 public @interface Many {
+  /**
+   * Returns the statement id that retrieves collection.
+   *
+   * @return the statement id
+   */
   String select() default "";
 
+  /**
+   * Returns the fetch strategy for nested statement.
+   *
+   * @return the fetch strategy
+   */
   FetchType fetchType() default FetchType.DEFAULT;
 
 }