Add JavaDoc to org.seasar.doma.jdbc.query package

doma-core/src/main/java/org/seasar/doma/jdbc/query/AbstractCreateQuery.java

@@ -17,19 +17,30 @@
 
 import org.seasar.doma.jdbc.Sql;
 
+/**
+ * An abstract base class for queries that create database resources.
+ *
+ * <p>This class provides a skeletal implementation of the {@link CreateQuery} interface, reducing
+ * the effort required to implement resource creation queries.
+ *
+ * @param <RESULT> the type of the resource to be created
+ */
 public abstract class AbstractCreateQuery<RESULT> extends AbstractQuery
     implements CreateQuery<RESULT> {
 
+  /** {@inheritDoc} */
   @Override
   public int getQueryTimeout() {
     return -1;
   }
 
+  /** {@inheritDoc} */
   @Override
   public Sql<?> getSql() {
     return null;
   }
 
+  /** {@inheritDoc} */
   @Override
   public void complete() {}
 }

doma-core/src/main/java/org/seasar/doma/jdbc/query/AbstractQuery.java

@@ -21,79 +21,129 @@
 import org.seasar.doma.jdbc.CommentContext;
 import org.seasar.doma.jdbc.Config;
 
+/**
+ * The base abstract class for all query implementations.
+ *
+ * <p>This class provides common functionality for all query types.
+ */
 public abstract class AbstractQuery implements Query {
 
+  /** The class name of the caller. */
   protected String callerClassName;
 
+  /** The method name of the caller. */
   protected String callerMethodName;
 
+  /** The configuration. */
   protected Config config;
 
+  /** The method that defines the query. */
   protected Method method;
 
+  /** The query timeout in seconds. */
   protected int queryTimeout;
 
+  /** The message to be included in SQL comments. */
   protected String message;
 
+  /** The context for SQL comments. */
   private CommentContext commentContext;
 
+  /** Creates a new instance. */
   protected AbstractQuery() {}
 
+  /** {@inheritDoc} */
   @Override
   public String getClassName() {
     return callerClassName;
   }
 
+  /**
+   * Sets the class name of the caller.
+   *
+   * @param callerClassName the class name
+   */
   public void setCallerClassName(String callerClassName) {
     this.callerClassName = callerClassName;
   }
 
+  /** {@inheritDoc} */
   @Override
   public String getMethodName() {
     return callerMethodName;
   }
 
+  /**
+   * Sets the method name of the caller.
+   *
+   * @param callerMethodName the method name
+   */
   public void setCallerMethodName(String callerMethodName) {
     this.callerMethodName = callerMethodName;
   }
 
+  /** {@inheritDoc} */
   @Override
   public Config getConfig() {
     return config;
   }
 
+  /**
+   * Sets the configuration.
+   *
+   * @param config the configuration
+   */
   public void setConfig(Config config) {
     this.config = config;
   }
 
+  /** {@inheritDoc} */
   @Override
   public Method getMethod() {
     return method;
   }
 
+  /**
+   * Sets the method that defines the query.
+   *
+   * @param method the method
+   */
   public void setMethod(Method method) {
     this.method = method;
   }
 
+  /** {@inheritDoc} */
   @Override
   public int getQueryTimeout() {
     return queryTimeout;
   }
 
+  /**
+   * Sets the query timeout in seconds.
+   *
+   * @param queryTimeout the query timeout
+   */
   public void setQueryTimeout(int queryTimeout) {
     this.queryTimeout = queryTimeout;
   }
 
+  /**
+   * Sets the message to be included in SQL comments.
+   *
+   * @param message the message
+   */
   public void setMessage(String message) {
     this.message = message;
   }
 
+  /** {@inheritDoc} */
   @Override
   public void prepare() {
     assertNotNull(callerClassName, callerMethodName, config);
     commentContext = new CommentContext(callerClassName, callerMethodName, config, method, message);
   }
 
+  /** {@inheritDoc} */
   @Override
   public String comment(String sql) {
     assertNotNull(sql, config, commentContext);