JdbcMappingHint にJavaDocコメントを追加

Author: nakamura-to

src/main/java/org/seasar/doma/jdbc/JdbcMappingHint.java

@@ -18,10 +18,24 @@
 import java.util.Optional;
 
 /**
+ * マッピングに関するヒント情報です。
+ * <p>
+ * {@link JdbcMappingVisitor} の実装クラスにおいて、次のマッピングのカスタマイズに利用できます。
+ * 
+ * <ul>
+ * <li>JavaのクラスからSQLの型へのマッピング（JavaからSQLのバインド変数へのマッピング）</li>
+ * <li>SQLの型からJavaのクラスへのマッピング（SQLの結果セットからJavaのマッピング）</li>
+ * </ul>
+ * 
  * @author nakamura-to
  * 
  */
 public interface JdbcMappingHint {
 
+    /**
+     * ドメインクラスにマッピングされている場合、そのドメインクラスを返します。
+     * 
+     * @return ドメインクラス
+     */
     Optional<Class<?>> getDomainClass();
 }