Add javadoc on SQL provider annotation

Related with gh-1279

Author: kazuki43zoo

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

@@ -28,7 +28,33 @@
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.METHOD)
 public @interface DeleteProvider {
+
+  /**
+   * Specify a type that implements an SQL provider method.
+   *
+   * @return a type that implements an SQL provider method
+   */
   Class<?> type();
 
+  /**
+   * Specify a method for providing an SQL.
+   *
+   * <p>
+   * Since 3.5.1, this attribute can omit.
+   * If this attribute omit, the MyBatis will call a method that decide by following rules.
+   * <ul>
+   *   <li>
+   *     If class that specified the {@link #type()} attribute implements the {@link org.apache.ibatis.builder.annotation.ProviderMethodResolver},
+   *     the MyBatis use a method that returned by it
+   *   </li>
+   *   <li>
+   *     If cannot resolve a method by {@link org.apache.ibatis.builder.annotation.ProviderMethodResolver}(= not implement it or it was returned {@code null}),
+   *     the MyBatis will search and use a fallback method that named {@code resolveSql} from specified type
+   *   </li>
+   * </ul>
+   *
+   * @return a method name of method for providing an SQL
+   */
   String method() default "";
+
 }

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

@@ -28,7 +28,33 @@
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.METHOD)
 public @interface InsertProvider {
+
+  /**
+   * Specify a type that implements an SQL provider method.
+   *
+   * @return a type that implements an SQL provider method
+   */
   Class<?> type();
 
+  /**
+   * Specify a method for providing an SQL.
+   *
+   * <p>
+   * Since 3.5.1, this attribute can omit.
+   * If this attribute omit, the MyBatis will call a method that decide by following rules.
+   * <ul>
+   *   <li>
+   *     If class that specified the {@link #type()} attribute implements the {@link org.apache.ibatis.builder.annotation.ProviderMethodResolver},
+   *     the MyBatis use a method that returned by it
+   *   </li>
+   *   <li>
+   *     If cannot resolve a method by {@link org.apache.ibatis.builder.annotation.ProviderMethodResolver}(= not implement it or it was returned {@code null}),
+   *     the MyBatis will search and use a fallback method that named {@code resolveSql} from specified type
+   *   </li>
+   * </ul>
+   *
+   * @return a method name of method for providing an SQL
+   */
   String method() default "";
+
 }

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

@@ -28,7 +28,33 @@
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.METHOD)
 public @interface SelectProvider {
+
+  /**
+   * Specify a type that implements an SQL provider method.
+   *
+   * @return a type that implements an SQL provider method
+   */
   Class<?> type();
 
+  /**
+   * Specify a method for providing an SQL.
+   *
+   * <p>
+   * Since 3.5.1, this attribute can omit.
+   * If this attribute omit, the MyBatis will call a method that decide by following rules.
+   * <ul>
+   *   <li>
+   *     If class that specified the {@link #type()} attribute implements the {@link org.apache.ibatis.builder.annotation.ProviderMethodResolver},
+   *     the MyBatis use a method that returned by it
+   *   </li>
+   *   <li>
+   *     If cannot resolve a method by {@link org.apache.ibatis.builder.annotation.ProviderMethodResolver}(= not implement it or it was returned {@code null}),
+   *     the MyBatis will search and use a fallback method that named {@code resolveSql} from specified type
+   *   </li>
+   * </ul>
+   *
+   * @return a method name of method for providing an SQL
+   */
   String method() default "";
+
 }

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

@@ -28,7 +28,33 @@
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.METHOD)
 public @interface UpdateProvider {
+
+  /**
+   * Specify a type that implements an SQL provider method.
+   *
+   * @return a type that implements an SQL provider method
+   */
   Class<?> type();
 
+  /**
+   * Specify a method for providing an SQL.
+   *
+   * <p>
+   * Since 3.5.1, this attribute can omit.
+   * If this attribute omit, the MyBatis will call a method that decide by following rules.
+   * <ul>
+   *   <li>
+   *     If class that specified the {@link #type()} attribute implements the {@link org.apache.ibatis.builder.annotation.ProviderMethodResolver},
+   *     the MyBatis use a method that returned by it
+   *   </li>
+   *   <li>
+   *     If cannot resolve a method by {@link org.apache.ibatis.builder.annotation.ProviderMethodResolver}(= not implement it or it was returned {@code null}),
+   *     the MyBatis will search and use a fallback method that named {@code resolveSql} from specified type
+   *   </li>
+   * </ul>
+   *
+   * @return a method name of method for providing an SQL
+   */
   String method() default "";
+
 }