This is an automated email from the ASF dual-hosted git repository. jhyde pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/calcite.git
commit a47492bf8a0a310b49379b45ad2c15243393e094 Author: Julian Hyde <[email protected]> AuthorDate: Wed Sep 25 01:19:21 2019 -0700 Javadoc fixes for JDK 13 --- .../java/org/apache/calcite/plan/RelTrait.java | 2 +- .../calcite/rel/rules/IntersectToDistinctRule.java | 2 +- .../apache/calcite/sql/SqlJdbcFunctionCall.java | 14 +++++++------- .../apache/calcite/sql/validate/SelectScope.java | 4 ++-- .../sql/validate/implicit/package-info.java | 22 ++++++++++++++-------- .../main/java/org/apache/calcite/util/Static.java | 2 +- .../main/java/org/apache/calcite/util/Util.java | 12 ++++++------ .../apache/calcite/util/trace/CalciteTrace.java | 2 +- .../calcite/test/concurrent/package-info.java | 20 ++++++++++---------- .../java/org/apache/calcite/linq4j/Enumerator.java | 2 +- .../java/org/apache/calcite/linq4j/Extensions.java | 2 +- 11 files changed, 45 insertions(+), 39 deletions(-) diff --git a/core/src/main/java/org/apache/calcite/plan/RelTrait.java b/core/src/main/java/org/apache/calcite/plan/RelTrait.java index 0d9472c..2e3475b 100644 --- a/core/src/main/java/org/apache/calcite/plan/RelTrait.java +++ b/core/src/main/java/org/apache/calcite/plan/RelTrait.java @@ -21,7 +21,7 @@ package org.apache.calcite.plan; * a trait definition. For example, a {@code CallingConvention.JAVA} is a trait * of the {@link ConventionTraitDef} trait definition. * - * <h3><a id="EqualsHashCodeNote">Note about equals() and hashCode()</a></h3> + * <h2><a id="EqualsHashCodeNote">Note about equals() and hashCode()</a></h2> * * <p>If all instances of RelTrait for a particular RelTraitDef are defined in * an {@code enum} and no new RelTraits can be introduced at runtime, you need diff --git a/core/src/main/java/org/apache/calcite/rel/rules/IntersectToDistinctRule.java b/core/src/main/java/org/apache/calcite/rel/rules/IntersectToDistinctRule.java index cf16557..a03f61c 100644 --- a/core/src/main/java/org/apache/calcite/rel/rules/IntersectToDistinctRule.java +++ b/core/src/main/java/org/apache/calcite/rel/rules/IntersectToDistinctRule.java @@ -41,7 +41,7 @@ import java.math.BigDecimal; * * <p> Rewrite: (GB-Union All-GB)-GB-UDTF (on all attributes) * - * <h3>Example</h3> + * <h2>Example</h2> * * <p>Query: <code>R1 Intersect All R2</code> * diff --git a/core/src/main/java/org/apache/calcite/sql/SqlJdbcFunctionCall.java b/core/src/main/java/org/apache/calcite/sql/SqlJdbcFunctionCall.java index 9757b1f..84fe73f 100644 --- a/core/src/main/java/org/apache/calcite/sql/SqlJdbcFunctionCall.java +++ b/core/src/main/java/org/apache/calcite/sql/SqlJdbcFunctionCall.java @@ -50,7 +50,7 @@ import static org.apache.calcite.util.Static.RESOURCE; * <tr> * <td colspan="2"><br> * - * <h3>NUMERIC FUNCTIONS</h3> + * <h2>NUMERIC FUNCTIONS</h2> * </td> * </tr> * <tr> @@ -107,7 +107,7 @@ import static org.apache.calcite.util.Static.RESOURCE; * </tr> * <tr> * <td>MOD(integer1, integer2)</td> - * <td>Rh3ainder for integer1 / integer2</td> + * <td>Remainder for integer1 / integer2</td> * </tr> * <tr> * <td>PI()</td> @@ -153,7 +153,7 @@ import static org.apache.calcite.util.Static.RESOURCE; * <tr> * <td colspan="2"><br> * - * <h3>STRING FUNCTIONS</h3> + * <h2>STRING FUNCTIONS</h2> * </td> * </tr> * <tr> @@ -202,7 +202,7 @@ import static org.apache.calcite.util.Static.RESOURCE; * </tr> * <tr> * <td>LTRIM(string)</td> - * <td>Characters of string with leading blank spaces rh3oved</td> + * <td>Characters of string with leading blank spaces removed</td> * </tr> * <tr> * <td>REPEAT(string, count)</td> @@ -246,7 +246,7 @@ import static org.apache.calcite.util.Static.RESOURCE; * <tr> * <td colspan="2"><br> * - * <h3>TIME and DATE FUNCTIONS</h3> + * <h2>TIME and DATE FUNCTIONS</h2> * </td> * </tr> * <tr> @@ -331,7 +331,7 @@ import static org.apache.calcite.util.Static.RESOURCE; * <tr> * <td colspan="2"><br> * - * <h3>SYSTEM FUNCTIONS</h3> + * <h2>SYSTEM FUNCTIONS</h2> * </td> * </tr> * <tr> @@ -349,7 +349,7 @@ import static org.apache.calcite.util.Static.RESOURCE; * <tr> * <td colspan="2"><br> * - * <h3>CONVERSION FUNCTIONS</h3> + * <h2>CONVERSION FUNCTIONS</h2> * </td> * </tr> * <tr> diff --git a/core/src/main/java/org/apache/calcite/sql/validate/SelectScope.java b/core/src/main/java/org/apache/calcite/sql/validate/SelectScope.java index 6550e0b..4636125 100644 --- a/core/src/main/java/org/apache/calcite/sql/validate/SelectScope.java +++ b/core/src/main/java/org/apache/calcite/sql/validate/SelectScope.java @@ -48,7 +48,7 @@ import java.util.List; * {@link SqlValidatorNamespace} when resolving 'name', and * as a {@link SqlValidatorScope} when resolving 'gender'.</p> * - * <h3>Scopes</h3> + * <h2>Scopes</h2> * * <p>In the query</p> * @@ -72,7 +72,7 @@ import java.util.List; * defined in the SELECT clause</li> * </ul> * - * <h3>Namespaces</h3> + * <h2>Namespaces</h2> * * <p>In the above query, there are 4 namespaces:</p> * diff --git a/core/src/main/java/org/apache/calcite/sql/validate/implicit/package-info.java b/core/src/main/java/org/apache/calcite/sql/validate/implicit/package-info.java index 4fb46fe..66eb30c 100644 --- a/core/src/main/java/org/apache/calcite/sql/validate/implicit/package-info.java +++ b/core/src/main/java/org/apache/calcite/sql/validate/implicit/package-info.java @@ -16,10 +16,13 @@ */ /** - * <h1>SQL Implicit Type Cast</h1> - * <h2>Work Flow</h2> - * This package contains rules for implicit type coercion, it works during the process of sql - * validation. The transformation entrance are all kinds of checkers. i.e. + * <h2>SQL Implicit Type Cast</h2> + * + * <h3>Work Flow</h3> + * + * <p>This package contains rules for implicit type coercion, it works during + * the process of SQL validation. The transformation entrance are all kinds of + * checkers. i.e. * {@link org.apache.calcite.sql.type.AssignableOperandTypeChecker AssignableOperandTypeChecker}, * {@link org.apache.calcite.sql.type.ComparableOperandTypeChecker ComparableOperandTypeChecker} * {@link org.apache.calcite.sql.type.CompositeOperandTypeChecker CompositeOperandTypeChecker}, @@ -52,9 +55,11 @@ * eagerly here: the result expression would be transformed to "1 > cast('1' as int)" and * the result would be true. * - * <h2>Conversion SQL Contexts</h2> - * The supported conversion contexts are: + * <h3>Conversion SQL Contexts</h3> + * + * <p>The supported conversion contexts are: * <a href="https://docs.google.com/document/d/1g2RUnLXyp_LjUlO-wbblKuP5hqEu3a_2Mt2k4dh6RwU/edit?usp=sharing";>Conversion Expressions</a> + * * <p>Strategies for Finding Common Type:</p> * <ul> * <li>If the operator has expected data types, just take them as the desired one. i.e. the UDF. @@ -70,8 +75,9 @@ * or promote to STRING.</li> * </ul> * - * <h2>Type Conversion Matrix</h2> - * See <a href="https://docs.google.com/spreadsheets/d/1GhleX5h5W8-kJKh7NMJ4vtoE78pwfaZRJl88ULX_MgU/edit?usp=sharing";>CalciteImplicitCasts</a> + * <h3>Type Conversion Matrix</h3> + * + * <p>See <a href="https://docs.google.com/spreadsheets/d/1GhleX5h5W8-kJKh7NMJ4vtoE78pwfaZRJl88ULX_MgU/edit?usp=sharing";>CalciteImplicitCasts</a>. */ @PackageMarker package org.apache.calcite.sql.validate.implicit; diff --git a/core/src/main/java/org/apache/calcite/util/Static.java b/core/src/main/java/org/apache/calcite/util/Static.java index 21fd861..a9dfc37 100644 --- a/core/src/main/java/org/apache/calcite/util/Static.java +++ b/core/src/main/java/org/apache/calcite/util/Static.java @@ -25,7 +25,7 @@ import java.util.List; /** * Definitions of objects to be statically imported. * - * <h3>Note to developers</h3> + * <h2>Note to developers</h2> * * <p>Please give careful consideration before including an object in this * class. Pros: diff --git a/core/src/main/java/org/apache/calcite/util/Util.java b/core/src/main/java/org/apache/calcite/util/Util.java index 289cf63..6f6091e 100644 --- a/core/src/main/java/org/apache/calcite/util/Util.java +++ b/core/src/main/java/org/apache/calcite/util/Util.java @@ -477,7 +477,7 @@ public class Util { /** * Prints a string, enclosing in double quotes (") and escaping if - * necessary. For examples, <code>printDoubleQuoted(w,"x\"y",false)</code> + * necessary. For example, <code>printDoubleQuoted(w,"x\"y",false)</code> * prints <code>"x\"y"</code>. * * <p>The appendable where the value is printed must not incur I/O operations. This method is @@ -988,10 +988,10 @@ public class Util { * * <p>but the usual usage is to pass in a descriptive string. * - * <h3>Examples</h3> + * <p><b>Examples</b> * - * <h4>Example #1: Using <code>deprecated</code> to fail if a piece of - * supposedly dead code is reached</h4> + * <p><b>Example #1: Using <code>deprecated</code> to fail if a piece of + * supposedly dead code is reached</b> * * <blockquote> * <pre><code>void foo(int x) { @@ -1006,8 +1006,8 @@ public class Util { * }</code></pre> * </blockquote> * - * <h4>Example #2: Using <code>deprecated</code> to comment out dead - * code</h4> + * <p><b>Example #2: Using <code>deprecated</code> to comment out dead + * code</b> * * <blockquote> * <pre>if (Util.deprecated(false, false)) { diff --git a/core/src/main/java/org/apache/calcite/util/trace/CalciteTrace.java b/core/src/main/java/org/apache/calcite/util/trace/CalciteTrace.java index 70d77af..25b5a77 100644 --- a/core/src/main/java/org/apache/calcite/util/trace/CalciteTrace.java +++ b/core/src/main/java/org/apache/calcite/util/trace/CalciteTrace.java @@ -31,7 +31,7 @@ import java.io.File; * Contains all of the {@link org.slf4j.Logger tracers} used within * org.apache.calcite class libraries. * - * <h3>Note to developers</h3> + * <h2>Note to developers</h2> * * <p>Please ensure that every tracer used in org.apache.calcite is added to * this class as a <em>public static final</em> member called <code> diff --git a/core/src/test/java/org/apache/calcite/test/concurrent/package-info.java b/core/src/test/java/org/apache/calcite/test/concurrent/package-info.java index 84d1813..4d84965 100644 --- a/core/src/test/java/org/apache/calcite/test/concurrent/package-info.java +++ b/core/src/test/java/org/apache/calcite/test/concurrent/package-info.java @@ -31,9 +31,9 @@ * <code>mtsql</code> format, as described below. An instance of * <code>ConcurrentCommandScript</code> parses and executes a script.</p> * - * <h3>Script Format</h3> + * <h2>Script Format</h2> * - * <h4>Syntax:</h4> + * <h3>Syntax:</h3> * * <p>The syntactic structure of an <i>mtsql</i> script is: * @@ -62,14 +62,14 @@ * can * span lines and ends with a semicolon. * - * <h4>Semantics:</h4> + * <h3>Semantics:</h3> * * <p>Running a section means running its commands in sequence. * First the setup section (if any) is run. * Next all the thread sections are run at once, each in its own thread. * When all these threads complete, the cleanup section (if any) is run. * - * <h4>Synchronization:</h4> + * <h3>Synchronization:</h3> * * <p>The threads are synchronized by inserting synchronization points * (@sync).</p> @@ -88,7 +88,7 @@ * antonym @enable.</p> * * - * <h4>Error handling: </h4> + * <h3>Error handling:</h3> * * <p>When a sql command fails, the rest of its section is skipped. However, if * the attribute <i>force</i> is true the error is ignored, and the section @@ -103,7 +103,7 @@ * cleanup section runs. If the setup section quits, then only the cleanup * section is run.</p> * - * <h4>Basic Commands (allowed in any section):</h4> + * <h3>Basic Commands (allowed in any section):</h3> * * <blockquote><pre> * <SQL statement>: @@ -116,7 +116,7 @@ * Inclusions may nest. * </pre></blockquote> * - * <h4>Threaded Commands (allowed only in a @thread section):</h4> + * <h3>Threaded Commands (allowed only in a @thread section):</h3> * * <blockquote><pre> * @sleep N -- thread sleeps for N milliseconds @@ -163,7 +163,7 @@ * line ends with a single '\'. * </pre></blockquote> * - * <h4>Substituted Variables</h4> + * <h3>Substituted Variables</h3> * * <p>Needed mainly to pass arguments to the command of @shell, but also * useful to @@ -191,7 +191,7 @@ * different value when the script is run, by employing a phrase * VAR=VALUE on the mtsql command line.</p> * - * <h4>Stand-Alone Tool</h4> + * <h3>Stand-Alone Tool</h3> * * <p>A command-line tool that runs an mtsql script against a specified JDBC * connection,a nd prints the query results. (But see @print command to @@ -208,7 +208,7 @@ * declared at the beginning of the script(s) in a @var command.</p> * * - * <h4>Example Script</h4> + * <h3>Example Script</h3> * * <blockquote><pre>-- redundant: * @nolockstep diff --git a/linq4j/src/main/java/org/apache/calcite/linq4j/Enumerator.java b/linq4j/src/main/java/org/apache/calcite/linq4j/Enumerator.java index 46e08cb..5b077dc 100644 --- a/linq4j/src/main/java/org/apache/calcite/linq4j/Enumerator.java +++ b/linq4j/src/main/java/org/apache/calcite/linq4j/Enumerator.java @@ -106,7 +106,7 @@ public interface Enumerator<T> extends AutoCloseable { * <p>This method is optional; it may throw * {@link UnsupportedOperationException}. * - * <h3>Notes to Implementers</h3> + * <p><b>Notes to Implementers</b> * * <p>All calls to Reset must result in the same state for the enumerator. * The preferred implementation is to move the enumerator to the beginning diff --git a/linq4j/src/main/java/org/apache/calcite/linq4j/Extensions.java b/linq4j/src/main/java/org/apache/calcite/linq4j/Extensions.java index 7f288da..4b92d60 100644 --- a/linq4j/src/main/java/org/apache/calcite/linq4j/Extensions.java +++ b/linq4j/src/main/java/org/apache/calcite/linq4j/Extensions.java @@ -25,7 +25,7 @@ import java.util.Map; /** * Contains what, in LINQ.NET, would be extension methods. * - * <h3>Notes on mapping from LINQ.NET to Java</h3> + * <h2>Notes on mapping from LINQ.NET to Java</h2> * * <p>We have preserved most of the API. But we've changed a few things, so that * the API is more typical Java API:</p>
