diff --git a/jOOQ-tools/src/org/jooq/xtend/Factory.xtend b/jOOQ-tools/src/org/jooq/xtend/Factory.xtend index feb8f414d3..4c464813fd 100644 --- a/jOOQ-tools/src/org/jooq/xtend/Factory.xtend +++ b/jOOQ-tools/src/org/jooq/xtend/Factory.xtend @@ -169,7 +169,7 @@ class Factory extends Generators { out.append(''' /** - * Create a row value expression of degree «degree» + * Create a row value expression of degree «degree». *

* Note: Not all databases support row value expressions, but many row value * expression operations can be simulated on all databases. See relevant row @@ -193,7 +193,7 @@ class Factory extends Generators { out.append(''' /** - * Create a row value expression of degree «degree» + * Create a row value expression of degree «degree». *

* Note: Not all databases support row value expressions, but many row value * expression operations can be simulated on all databases. See relevant row @@ -217,7 +217,7 @@ class Factory extends Generators { out.append(''' /** - * Create a VALUES() expression of degree «degree» + * Create a VALUES() expression of degree «degree». *

* The VALUES() constructor is a tool supported by some * databases to allow for constructing tables from constant values. diff --git a/jOOQ/src/main/java/org/jooq/impl/Executor.java b/jOOQ/src/main/java/org/jooq/impl/Executor.java index dddcc3d02d..34af9e2ed3 100644 --- a/jOOQ/src/main/java/org/jooq/impl/Executor.java +++ b/jOOQ/src/main/java/org/jooq/impl/Executor.java @@ -252,7 +252,7 @@ public class Executor implements Configuration { } /** - * Create an executor with a dialect and settings configured + * Create an executor with a dialect and settings configured. *

* Without a connection or data source, this executor cannot execute * queries. Use it to render SQL only. @@ -372,7 +372,7 @@ public class Executor implements Configuration { } /** - * Create an executor from a custom configuration + * Create an executor from a custom configuration. * * @param configuration The configuration */ @@ -441,11 +441,16 @@ public class Executor implements Configuration { // XXX Convenience methods accessing the underlying Connection // ------------------------------------------------------------------------- + /** + * Access the database meta data. + *

+ * This method returns a wrapper type that gives access to your JDBC + * connection's database meta data. + */ public final Meta meta() { return new MetaImpl(this); } - // ------------------------------------------------------------------------- // XXX RenderContext and BindContext accessors // ------------------------------------------------------------------------- @@ -728,8 +733,10 @@ public class Executor implements Configuration { } /** - * Execute a new query holding plain SQL. There must be as many bind - * variables contained in the SQL, as passed in the bindings parameter + * Execute a new query holding plain SQL. + *

+ * There must be as many bind variables contained in the SQL, as passed in + * the bindings parameter *

* Example (Postgres): *

@@ -825,8 +832,10 @@ public class Executor implements Configuration { /** * Execute a new query holding plain SQL and "lazily" return the generated - * result. There must be as many bind variables contained in the SQL, as - * passed in the bindings parameter + * result. + *

+ * There must be as many bind variables contained in the SQL, as passed in + * the bindings parameter *

* The returned {@link Cursor} holds a reference to the executed * {@link PreparedStatement} and the associated {@link ResultSet}. Data can @@ -899,7 +908,7 @@ public class Executor implements Configuration { /** * Execute a new query holding plain SQL, possibly returning several result - * sets + * sets. *

* Example (Sybase ASE): *

@@ -924,8 +933,10 @@ public class Executor implements Configuration { /** * Execute a new query holding plain SQL, possibly returning several result - * sets. There must be as many bind variables contained in the SQL, as - * passed in the bindings parameter + * sets. + *

+ * There must be as many bind variables contained in the SQL, as passed in + * the bindings parameter *

* Example (Sybase ASE): *

@@ -1012,8 +1023,10 @@ public class Executor implements Configuration { } /** - * Execute a new query holding plain SQL. There must be as many bind - * variables contained in the SQL, as passed in the bindings parameter + * Execute a new query holding plain SQL. + *

+ * There must be as many bind variables contained in the SQL, as passed in + * the bindings parameter *

* Example (Postgres): *

@@ -1093,8 +1106,10 @@ public class Executor implements Configuration { } /** - * Execute a new query holding plain SQL. There must be as many bind - * variables contained in the SQL, as passed in the bindings parameter + * Execute a new query holding plain SQL. + *

+ * There must be as many bind variables contained in the SQL, as passed in + * the bindings parameter *

* NOTE: When inserting plain SQL into jOOQ objects, you must * guarantee syntax integrity. You may also create the possibility of @@ -1144,8 +1159,9 @@ public class Executor implements Configuration { } /** - * Create a new query holding plain SQL. There must not be any binding - * variables contained in the SQL + * Create a new query holding plain SQL. + *

+ * There must not be any binding variables contained in the SQL *

* Use this method, when you want to take advantage of the many ways to * fetch results in jOOQ, using {@link ResultQuery}. Some examples: @@ -1194,8 +1210,10 @@ public class Executor implements Configuration { } /** - * Create a new query holding plain SQL. There must be as many bind - * variables contained in the SQL, as passed in the bindings parameter + * Create a new query holding plain SQL. + *

+ * There must be as many bind variables contained in the SQL, as passed in + * the bindings parameter *

* Use this method, when you want to take advantage of the many ways to * fetch results in jOOQ, using {@link ResultQuery}. Some examples: @@ -1280,8 +1298,9 @@ public class Executor implements Configuration { /** * Fetch all data from a JDBC {@link ResultSet} and transform it to a jOOQ - * {@link Result}. After fetching all data, the JDBC ResultSet will be - * closed. + * {@link Result}. + *

+ * After fetching all data, the JDBC ResultSet will be closed. *

* Use {@link #fetchLazy(ResultSet)}, to fetch one Record at a * time, instead of load the entire ResultSet into a jOOQ @@ -1298,7 +1317,9 @@ public class Executor implements Configuration { /** * Fetch all data from a JDBC {@link ResultSet} and transform it to a jOOQ - * {@link Result}. After fetching all data, the JDBC ResultSet will be + * {@link Result}. + *

+ * After fetching all data, the JDBC ResultSet will be * closed. *

* Use {@link #fetchLazy(ResultSet)}, to fetch one Record at a @@ -1320,7 +1341,9 @@ public class Executor implements Configuration { /** * Fetch all data from a JDBC {@link ResultSet} and transform it to a jOOQ - * {@link Result}. After fetching all data, the JDBC ResultSet will be + * {@link Result}. + *

+ * After fetching all data, the JDBC ResultSet will be * closed. *

* Use {@link #fetchLazy(ResultSet)}, to fetch one Record at a @@ -1342,7 +1365,9 @@ public class Executor implements Configuration { /** * Fetch all data from a JDBC {@link ResultSet} and transform it to a jOOQ - * {@link Result}. After fetching all data, the JDBC ResultSet will be + * {@link Result}. + *

+ * After fetching all data, the JDBC ResultSet will be * closed. *

* Use {@link #fetchLazy(ResultSet)}, to fetch one Record at a @@ -1364,7 +1389,9 @@ public class Executor implements Configuration { /** * Fetch a record from a JDBC {@link ResultSet} and transform it to a jOOQ - * {@link Record}. This will internally fetch all records and throw an + * {@link Record}. + *

+ * This will internally fetch all records and throw an * exception if there was more than one resulting record. * * @param rs The JDBC ResultSet to fetch data from @@ -1379,7 +1406,9 @@ public class Executor implements Configuration { /** * Fetch a record from a JDBC {@link ResultSet} and transform it to a jOOQ - * {@link Record}. This will internally fetch all records and throw an + * {@link Record}. + *

+ * This will internally fetch all records and throw an * exception if there was more than one resulting record. *

* The additional fields argument is used by jOOQ to coerce @@ -1398,7 +1427,9 @@ public class Executor implements Configuration { /** * Fetch a record from a JDBC {@link ResultSet} and transform it to a jOOQ - * {@link Record}. This will internally fetch all records and throw an + * {@link Record}. + *

+ * This will internally fetch all records and throw an * exception if there was more than one resulting record. *

* The additional types argument is used by jOOQ to coerce @@ -1417,7 +1448,9 @@ public class Executor implements Configuration { /** * Fetch a record from a JDBC {@link ResultSet} and transform it to a jOOQ - * {@link Record}. This will internally fetch all records and throw an + * {@link Record}. + *

+ * This will internally fetch all records and throw an * exception if there was more than one resulting record. *

* The additional types argument is used by jOOQ to coerce @@ -1636,7 +1669,7 @@ public class Executor implements Configuration { // ------------------------------------------------------------------------- /** - * Create a new DSL select statement + * Create a new DSL select statement. *

* Example: 

      * SELECT * FROM [table] WHERE [conditions] ORDER BY [ordering] LIMIT [limit clause]
diff --git a/jOOQ/src/main/java/org/jooq/impl/Factory.java b/jOOQ/src/main/java/org/jooq/impl/Factory.java
index befe03ed9e..14a09f13b2 100644
--- a/jOOQ/src/main/java/org/jooq/impl/Factory.java
+++ b/jOOQ/src/main/java/org/jooq/impl/Factory.java
@@ -142,7 +142,7 @@ import org.jooq.exception.SQLDialectNotSupportedException;
 import org.jooq.types.DayToSecond;
 
 /**
- * A factory providing implementations to the org.jooq interfaces
+ * A factory providing implementations to the org.jooq interfaces.
  * 

  * This factory is the main entry point for client code, to access jOOQ classes
  * and functionality. Here, you can instanciate all of those objects that cannot
@@ -246,7 +246,7 @@ public class Factory {
     }
 
     /**
-     * Create a new DSL select statement
+     * Create a new DSL select statement.
      * 

      * Unlike {@link Select} factory methods in the {@link Executor} API, this
      * creates an unattached, and thus not directly renderable or executable
@@ -2219,7 +2219,7 @@ public class Factory {
     // -------------------------------------------------------------------------
 
     /**
-     * A synonym for {@link Select#asTable()}. It might look a bit more fluent
+     * A synonym for {@link Select#asTable()}, which might look a bit more fluent
      * like this, to some users
      *
      * @see Select#asTable()
@@ -2229,7 +2229,7 @@ public class Factory {
     }
 
     /**
-     * A synonym for {@link #unnest(List)}
+     * A synonym for {@link #unnest(List)}.
      *
      * @see #unnest(List)
      */
@@ -2239,7 +2239,7 @@ public class Factory {
     }
 
     /**
-     * A synonym for {@link #unnest(Object[])}
+     * A synonym for {@link #unnest(Object[])}.
      *
      * @see #unnest(Object[])
      */
@@ -2249,7 +2249,7 @@ public class Factory {
     }
 
     /**
-     * A synonym for {@link #unnest(ArrayRecord)}
+     * A synonym for {@link #unnest(ArrayRecord)}.
      *
      * @see #unnest(ArrayRecord)
      */
@@ -2259,7 +2259,7 @@ public class Factory {
     }
 
     /**
-     * A synonym for {@link #unnest(Field)}
+     * A synonym for {@link #unnest(Field)}.
      *
      * @see #unnest(Field)
      */
@@ -2269,7 +2269,7 @@ public class Factory {
     }
 
     /**
-     * Create a table from a list of values
+     * Create a table from a list of values.
      * 

      * This is equivalent to the TABLE function for H2, or the
      * UNNEST function in HSQLDB and Postgres
@@ -2286,7 +2286,7 @@ public class Factory {
     }
 
     /**
-     * Create a table from an array of values
+     * Create a table from an array of values.
      * 

      * This is equivalent to the TABLE function for H2, or the
      * UNNEST function in HSQLDB and Postgres
@@ -2303,7 +2303,7 @@ public class Factory {
     }
 
     /**
-     * Create a table from an array of values
+     * Create a table from an array of values.
      * 

      * This wraps the argument array in a TABLE function for
      * Oracle. Currently, only Oracle knows typed arrays
@@ -2314,8 +2314,9 @@ public class Factory {
     }
 
     /**
-     * Create a table from a field. The supplied field can have any of these
-     * types:
+     * Create a table from a field.
+     * 

+     * The supplied field can have any of these types:
      *