You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@polygene.apache.org by ni...@apache.org on 2017/04/15 11:29:36 UTC

polygene-java git commit: Invalid javadocs now fails our build.

Repository: polygene-java
Updated Branches:
  refs/heads/develop dd97e30f7 -> 3e0fd0b72


Invalid javadocs now fails our build.

Signed-off-by: niclas <ni...@hedhman.org>


Project: http://git-wip-us.apache.org/repos/asf/polygene-java/repo
Commit: http://git-wip-us.apache.org/repos/asf/polygene-java/commit/3e0fd0b7
Tree: http://git-wip-us.apache.org/repos/asf/polygene-java/tree/3e0fd0b7
Diff: http://git-wip-us.apache.org/repos/asf/polygene-java/diff/3e0fd0b7

Branch: refs/heads/develop
Commit: 3e0fd0b72aca932243137208203f4acd7672baa7
Parents: dd97e30
Author: niclas <ni...@hedhman.org>
Authored: Sat Apr 15 19:29:07 2017 +0800
Committer: niclas <ni...@hedhman.org>
Committed: Sat Apr 15 19:29:07 2017 +0800

----------------------------------------------------------------------
 .../grammar/builders/query/QueryBuilder.java    |  4 +---
 .../grammar/factories/DataTypeFactory.java      | 24 +++++++++++++++-----
 .../grammar/factories/DefinitionFactory.java    | 20 ++++++++--------
 .../generator/implementation/TypeableImpl.java  |  2 +-
 .../sql/generator/vendor/PostgreSQLVendor.java  |  3 ---
 5 files changed, 30 insertions(+), 23 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/polygene-java/blob/3e0fd0b7/libraries/sql-generator/src/main/java/org/apache/polygene/library/sql/generator/grammar/builders/query/QueryBuilder.java
----------------------------------------------------------------------
diff --git a/libraries/sql-generator/src/main/java/org/apache/polygene/library/sql/generator/grammar/builders/query/QueryBuilder.java b/libraries/sql-generator/src/main/java/org/apache/polygene/library/sql/generator/grammar/builders/query/QueryBuilder.java
index 3ae57b3..15dde25 100644
--- a/libraries/sql-generator/src/main/java/org/apache/polygene/library/sql/generator/grammar/builders/query/QueryBuilder.java
+++ b/libraries/sql-generator/src/main/java/org/apache/polygene/library/sql/generator/grammar/builders/query/QueryBuilder.java
@@ -179,7 +179,6 @@ public interface QueryBuilder
      * {@code null} as second parameter.
      * </p>
      *
-     * @param setQuantifier The set quantifier for this union.
      * @param another       The query to perform {@code EXCEPT} with.
      * @return This builder.
      */
@@ -195,7 +194,7 @@ public interface QueryBuilder
      * {@link SetQuantifier#DISTINCT} as first parameter.
      * </p>
      *
-     * @param correspondingSpec The column correspondence specification.
+     * @param setQuantifier The set quantifier for this union.
      * @param another           The query to perform {@code EXCEPT} with.
      * @return This builder.
      */
@@ -205,7 +204,6 @@ public interface QueryBuilder
      * Adds {@code EXCEPT <setQuantifier> <correspondingSpec>} between current query and the given query. Then makes
      * resulting query the current query.
      *
-     * @param setQuantifier     The set quantifier for this union.
      * @param correspondingSpec The column correspondence specification. May be {@code null}.
      * @param another           The query to perform {@code EXCEPT} with.
      * @return This builder.

http://git-wip-us.apache.org/repos/asf/polygene-java/blob/3e0fd0b7/libraries/sql-generator/src/main/java/org/apache/polygene/library/sql/generator/grammar/factories/DataTypeFactory.java
----------------------------------------------------------------------
diff --git a/libraries/sql-generator/src/main/java/org/apache/polygene/library/sql/generator/grammar/factories/DataTypeFactory.java b/libraries/sql-generator/src/main/java/org/apache/polygene/library/sql/generator/grammar/factories/DataTypeFactory.java
index 85ffeed..5511a55 100644
--- a/libraries/sql-generator/src/main/java/org/apache/polygene/library/sql/generator/grammar/factories/DataTypeFactory.java
+++ b/libraries/sql-generator/src/main/java/org/apache/polygene/library/sql/generator/grammar/factories/DataTypeFactory.java
@@ -60,7 +60,9 @@ public interface DataTypeFactory
      * </p>
      * <p>
      * The site http://intelligent-enterprise.informationweek.com/000626/celko.jhtml explains difference between
-     * {@code NUMERIC} and {@code DECIMAL}:<br/>
+     * {@code NUMERIC} and {@code DECIMAL}:
+     * </p>
+     * <p>
      * The difference between DECIMAL(s,p) and NUMERIC(s,p) is subtle in the SQL-92 Standard -- DECIMAL(s,p) must be
      * exactly as precise as declared, while NUMERIC(s,p) must be at least as precise as declared.
      * </p>
@@ -76,7 +78,9 @@ public interface DataTypeFactory
      * </p>
      * <p>
      * The site http://intelligent-enterprise.informationweek.com/000626/celko.jhtml explains difference between
-     * {@code NUMERIC} and {@code DECIMAL}:<br/>
+     * {@code NUMERIC} and {@code DECIMAL}:
+     * </p>
+     * <p>
      * The difference between DECIMAL(s,p) and NUMERIC(s,p) is subtle in the SQL-92 Standard -- DECIMAL(s,p) must be
      * exactly as precise as declared, while NUMERIC(s,p) must be at least as precise as declared.
      * </p>
@@ -93,7 +97,9 @@ public interface DataTypeFactory
      * </p>
      * <p>
      * The site http://intelligent-enterprise.informationweek.com/000626/celko.jhtml explains difference between
-     * {@code NUMERIC} and {@code DECIMAL}:<br/>
+     * {@code NUMERIC} and {@code DECIMAL}:
+     * </p>
+     * <p>
      * The difference between DECIMAL(s,p) and NUMERIC(s,p) is subtle in the SQL-92 Standard -- DECIMAL(s,p) must be
      * exactly as precise as declared, while NUMERIC(s,p) must be at least as precise as declared.
      * </p>
@@ -118,7 +124,9 @@ public interface DataTypeFactory
      * </p>
      * <p>
      * The site http://intelligent-enterprise.informationweek.com/000626/celko.jhtml explains difference between
-     * {@code NUMERIC} and {@code DECIMAL}:<br/>
+     * {@code NUMERIC} and {@code DECIMAL}:
+     * </p>
+     * <p>
      * The difference between DECIMAL(s,p) and NUMERIC(s,p) is subtle in the SQL-92 Standard -- DECIMAL(s,p) must be
      * exactly as precise as declared, while NUMERIC(s,p) must be at least as precise as declared.
      * </p>
@@ -134,7 +142,9 @@ public interface DataTypeFactory
      * </p>
      * <p>
      * The site http://intelligent-enterprise.informationweek.com/000626/celko.jhtml explains difference between
-     * {@code NUMERIC} and {@code DECIMAL}:<br/>
+     * {@code NUMERIC} and {@code DECIMAL}:
+     * </p>
+     * <p>
      * The difference between DECIMAL(s,p) and NUMERIC(s,p) is subtle in the SQL-92 Standard -- DECIMAL(s,p) must be
      * exactly as precise as declared, while NUMERIC(s,p) must be at least as precise as declared.
      * </p>
@@ -151,7 +161,9 @@ public interface DataTypeFactory
      * </p>
      * <p>
      * The site http://intelligent-enterprise.informationweek.com/000626/celko.jhtml explains difference between
-     * {@code NUMERIC} and {@code DECIMAL}:<br/>
+     * {@code NUMERIC} and {@code DECIMAL}:
+     * </p>
+     * <p>
      * The difference between DECIMAL(s,p) and NUMERIC(s,p) is subtle in the SQL-92 Standard -- DECIMAL(s,p) must be
      * exactly as precise as declared, while NUMERIC(s,p) must be at least as precise as declared.
      * </p>

http://git-wip-us.apache.org/repos/asf/polygene-java/blob/3e0fd0b7/libraries/sql-generator/src/main/java/org/apache/polygene/library/sql/generator/grammar/factories/DefinitionFactory.java
----------------------------------------------------------------------
diff --git a/libraries/sql-generator/src/main/java/org/apache/polygene/library/sql/generator/grammar/factories/DefinitionFactory.java b/libraries/sql-generator/src/main/java/org/apache/polygene/library/sql/generator/grammar/factories/DefinitionFactory.java
index 850cbfe..edf5672 100644
--- a/libraries/sql-generator/src/main/java/org/apache/polygene/library/sql/generator/grammar/factories/DefinitionFactory.java
+++ b/libraries/sql-generator/src/main/java/org/apache/polygene/library/sql/generator/grammar/factories/DefinitionFactory.java
@@ -73,19 +73,19 @@ public interface DefinitionFactory
 
     /**
      * Creates a new definition of column with specified name and data type. Invoking this method is equivalent to
-     * invoking {@link #createColumnDefinition(String, String, String, Boolean)} and pass {@code null} and {@code true}
+     * invoking {@link #createColumnDefinition(String, SQLDataType, String, Boolean)} and pass {@code null} and {@code true}
      * as last two parameters (meaning that there is no default value for column, and it may have {@code NULL} values).
      *
      * @param columnName     The name of the column.
      * @param columnDataType The data type of the column.
      * @return The syntax element for definition of column with specified name and data type.
-     * @see #createColumnDefinition(String, String, String, Boolean)
+     * @see #createColumnDefinition(String, SQLDataType, String, Boolean)
      */
     ColumnDefinition createColumnDefinition( String columnName, SQLDataType columnDataType );
 
     /**
      * Creates a new definition of column with specified name, data type, and {@code NULL} value policy. Invoking this
-     * method is equivalent to invoking {@link #createColumnDefinition(String, String, String, Boolean)} and pass
+     * method is equivalent to invoking {@link #createColumnDefinition(String, SQLDataType, String, Boolean)} and pass
      * {@code null} and {@code mayBeNull} as last two parameters (meaning that there is no default value for column).
      *
      * @param columnName     The name of the column.
@@ -94,27 +94,27 @@ public interface DefinitionFactory
      *                       {@code NOT NULL} in column definition in SQL.
      * @return The syntax element for definition of column with specified name, data type, and {@code NULL} value
      * policy.
-     * @see #createColumnDefinition(String, String, String, Boolean)
+     * @see #createColumnDefinition(String, SQLDataType, String, Boolean)
      */
     ColumnDefinition createColumnDefinition( String columnName, SQLDataType columnDataType, Boolean mayBeNull );
 
     /**
      * Creates a new definition of column with specified name, data type, default value. Invoking this method is
-     * equivalent to invoking {@link #createColumnDefinition(String, String, String, Boolean)} and pass
+     * equivalent to invoking {@link #createColumnDefinition(String, SQLDataType, String, Boolean)} and pass
      * {@code columnDefault} and {@code true} as last two parameters (meaning that column may have {@code NULL} values).
      *
      * @param columnName     The name of the column.
      * @param columnDataType The data type of the column.
      * @param columnDefault  The default value of the column.
      * @return The syntax element for definition of column with specified name, data type, default value.
-     * @see #createColumnDefinition(String, String, String, Boolean)
+     * @see #createColumnDefinition(String, SQLDataType, String, Boolean)
      */
     ColumnDefinition createColumnDefinition( String columnName, SQLDataType columnDataType, String columnDefault );
 
     /**
      * Creates a new definition of column with specified name, data type, default value, and {@code NULL} value policy.
      * Invoking this method is equivalent to invoking
-     * {@link #createColumnDefinition(String, SQLDataType, String, Boolean, AutoGenerationPolicy)} and pass {@code null}
+     * {@link #createColumnDefinition(String, SQLDataType, Boolean, AutoGenerationPolicy)} and pass {@code null}
      * as last parameter.
      *
      * @param columnName     The name of the column.
@@ -163,7 +163,7 @@ public interface DefinitionFactory
      *
      * @param constraint The constraint for the table.
      * @return The syntax element for unnamed table constraint without any {@link ConstraintCharacteristics}.
-     * @see #createColumnDefinition(String, String, String, Boolean)
+     * @see #createColumnDefinition(String, SQLDataType, String, Boolean)
      */
     TableConstraintDefinition createTableConstraintDefinition( TableConstraint constraint );
 
@@ -176,7 +176,7 @@ public interface DefinitionFactory
      * @param name       The name for the constraint.
      * @param constraint The constraint for the table.
      * @return The syntax element for named table constraint without any {@link ConstraintCharacteristics}.
-     * @see #createColumnDefinition(String, String, String, Boolean)
+     * @see #createColumnDefinition(String, SQLDataType, String, Boolean)
      */
     TableConstraintDefinition createTableConstraintDefinition( String name, TableConstraint constraint );
 
@@ -189,7 +189,7 @@ public interface DefinitionFactory
      * @param constraint      The constraint for the table.
      * @param characteristics The constraint characteristics for the constraint.
      * @return The syntax element for unnamed table constraint with specified {@link ConstraintCharacteristics}.
-     * @see #createColumnDefinition(String, String, String, Boolean)
+     * @see #createColumnDefinition(String, SQLDataType, String, Boolean)
      * @see ConstraintCharacteristics
      */
     TableConstraintDefinition createTableConstraintDefinition( TableConstraint constraint,

http://git-wip-us.apache.org/repos/asf/polygene-java/blob/3e0fd0b7/libraries/sql-generator/src/main/java/org/apache/polygene/library/sql/generator/implementation/TypeableImpl.java
----------------------------------------------------------------------
diff --git a/libraries/sql-generator/src/main/java/org/apache/polygene/library/sql/generator/implementation/TypeableImpl.java b/libraries/sql-generator/src/main/java/org/apache/polygene/library/sql/generator/implementation/TypeableImpl.java
index 70c2e8b..8b36b64 100644
--- a/libraries/sql-generator/src/main/java/org/apache/polygene/library/sql/generator/implementation/TypeableImpl.java
+++ b/libraries/sql-generator/src/main/java/org/apache/polygene/library/sql/generator/implementation/TypeableImpl.java
@@ -83,7 +83,7 @@ public abstract class TypeableImpl<ImplementedType extends Typeable<?>, RealImpl
      * Override this method to test equaling to other objects implementing same API type as this.
      *
      * @param another Another object implementing same API type as {@code this}. Is guaranteed to be non-null and
-     *                different reference than {@code this}, when called by {@link Typeable#equals(Object)}.
+     *                different reference than {@code this}, when called by {@code Typeable#equals(Object)}.
      * @return {@code true} if this object equals to {@code another}; false otherwise.
      */
     protected abstract boolean doesEqual( RealImplementedType another );

http://git-wip-us.apache.org/repos/asf/polygene-java/blob/3e0fd0b7/libraries/sql-generator/src/main/java/org/apache/polygene/library/sql/generator/vendor/PostgreSQLVendor.java
----------------------------------------------------------------------
diff --git a/libraries/sql-generator/src/main/java/org/apache/polygene/library/sql/generator/vendor/PostgreSQLVendor.java b/libraries/sql-generator/src/main/java/org/apache/polygene/library/sql/generator/vendor/PostgreSQLVendor.java
index 8d92eca..13b1eaa 100644
--- a/libraries/sql-generator/src/main/java/org/apache/polygene/library/sql/generator/vendor/PostgreSQLVendor.java
+++ b/libraries/sql-generator/src/main/java/org/apache/polygene/library/sql/generator/vendor/PostgreSQLVendor.java
@@ -28,9 +28,6 @@ import org.apache.polygene.library.sql.generator.grammar.factories.pgsql.PgSQLMa
  * these elements.
  *
  * @author Stanislav Muhametsin
- * @see PgSQLQueryFactory
- * @see LimitClause
- * @see OffsetClause
  */
 public interface PostgreSQLVendor
     extends SQLVendor