You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@calcite.apache.org by jh...@apache.org on 2018/06/13 03:21:03 UTC
[3/4] calcite git commit: [CALCITE-2341] Fix javadoc for JDK 11
[CALCITE-2341] Fix javadoc for JDK 11
Close apache/calcite#726
Fix javadoc issues with JDK11 by updating javadoc plugin to 3.0.1
and updating HTML to comply with HTML5 spec.
Project: http://git-wip-us.apache.org/repos/asf/calcite/repo
Commit: http://git-wip-us.apache.org/repos/asf/calcite/commit/03dce133
Tree: http://git-wip-us.apache.org/repos/asf/calcite/tree/03dce133
Diff: http://git-wip-us.apache.org/repos/asf/calcite/diff/03dce133
Branch: refs/heads/master
Commit: 03dce1337c8c1d46ab050b55af426efa5f33c3a9
Parents: a9d6cfd
Author: Laurent Goujon <la...@online.fr>
Authored: Mon Jun 11 08:41:09 2018 -0700
Committer: Julian Hyde <jh...@apache.org>
Committed: Tue Jun 12 19:01:21 2018 -0500
----------------------------------------------------------------------
.../calcite/plan/RelOptSamplingParameters.java | 2 +-
.../java/org/apache/calcite/plan/RelTrait.java | 2 +-
.../calcite/plan/volcano/package-info.java | 2 +-
.../java/org/apache/calcite/util/Glossary.java | 150 +++++++++----------
.../calcite/test/concurrent/package-info.java | 2 +-
pom.xml | 4 +-
6 files changed, 81 insertions(+), 81 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/calcite/blob/03dce133/core/src/main/java/org/apache/calcite/plan/RelOptSamplingParameters.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/org/apache/calcite/plan/RelOptSamplingParameters.java b/core/src/main/java/org/apache/calcite/plan/RelOptSamplingParameters.java
index 7a50613..1621c44 100644
--- a/core/src/main/java/org/apache/calcite/plan/RelOptSamplingParameters.java
+++ b/core/src/main/java/org/apache/calcite/plan/RelOptSamplingParameters.java
@@ -84,7 +84,7 @@ public class RelOptSamplingParameters {
}
/**
- * If {@link #isRepeatable()} returns <tt>true</tt>, this method returns a
+ * If {@link #isRepeatable()} returns <code>true</code>, this method returns a
* user-specified seed value. Samples of the same, unmodified relation
* should be identical if the sampling mode, sampling percentage and
* repeatable seed are the same.
http://git-wip-us.apache.org/repos/asf/calcite/blob/03dce133/core/src/main/java/org/apache/calcite/plan/RelTrait.java
----------------------------------------------------------------------
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 e611e95..0d9472c 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 name="EqualsHashCodeNote">Note about equals() and hashCode()</a></h3>
+ * <h3><a id="EqualsHashCodeNote">Note about equals() and hashCode()</a></h3>
*
* <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
http://git-wip-us.apache.org/repos/asf/calcite/blob/03dce133/core/src/main/java/org/apache/calcite/plan/volcano/package-info.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/org/apache/calcite/plan/volcano/package-info.java b/core/src/main/java/org/apache/calcite/plan/volcano/package-info.java
index 9e47d75..a3816f6 100644
--- a/core/src/main/java/org/apache/calcite/plan/volcano/package-info.java
+++ b/core/src/main/java/org/apache/calcite/plan/volcano/package-info.java
@@ -262,7 +262,7 @@
* </ol>
* <h2>References</h2>
*
- * <p>1. <a name="graefe93" href="http://citeseer.nj.nec.com/graefe93volcano.html">The
+ * <p>1. <a id="graefe93" href="http://citeseer.nj.nec.com/graefe93volcano.html">The
* Volcano Optimizer
* Generator: Extensibility and Efficient Search - Goetz Graefe, William J.
* McKenna
http://git-wip-us.apache.org/repos/asf/calcite/blob/03dce133/core/src/main/java/org/apache/calcite/util/Glossary.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/org/apache/calcite/util/Glossary.java b/core/src/main/java/org/apache/calcite/util/Glossary.java
index 65ffd73..c1e3a1c 100644
--- a/core/src/main/java/org/apache/calcite/util/Glossary.java
+++ b/core/src/main/java/org/apache/calcite/util/Glossary.java
@@ -40,7 +40,7 @@ public interface Glossary {
* Craig's refinement of the type of problems they apply to and a refinement
* of the original three pattern categories.</p>
*
- * <table cellSpacing="0" cellPadding="3" border="1">
+ * <table style="border-spacing:0px;padding:3px;border:1px">
* <caption>
* <a href="http://www.onr.com/user/loeffler/java/references.html#gof">
* <b>Gang of Four Patterns</b></a>
@@ -49,18 +49,18 @@ public interface Glossary {
* <!-- Headers for each column -->
*
* <th>Pattern Name</th>
- * <th align="middle"><a href="#category">GOF Category</a></th>
- * <th align="middle">Problem</th>
- * <th align="middle">Pattern</th>
- * <th align="middle">Often Uses</th>
- * <th align="middle">Related To</th>
+ * <th style="text-align:middle"><a href="#category">GOF Category</a></th>
+ * <th style="text-align:middle">Problem</th>
+ * <th style="text-align:middle">Pattern</th>
+ * <th style="text-align:middle">Often Uses</th>
+ * <th style="text-align:middle">Related To</th>
* </tr>
*
* <!-- Frequently used patterns have a lime background -->
* <tr>
- * <td bgColor="lime"><a href="#AbstractFactoryPattern">Abstract Factory</a>
+ * <td style="background-color:lime"><a href="#AbstractFactoryPattern">Abstract Factory</a>
* </td>
- * <td bgColor="teal"><font color="white">Creational</font></td>
+ * <td style="background-color:teal;color:white">Creational</td>
* <td>Creating Instances</td>
* <td>Class/Interface Definition plus Inheritance</td>
* <td><a href="#FactoryMethodPattern">Factory Method</a><br>
@@ -73,19 +73,19 @@ public interface Glossary {
* </tr>
*
* <tr>
- * <td bgColor="lime"><a href="#ObjectAdapterPattern">Object Adapter</a>
+ * <td style="background-color:lime"><a href="#ObjectAdapterPattern">Object Adapter</a>
* </td>
- * <td bgColor="silver">Structural</td>
+ * <td style="background-color:silver">Structural</td>
* <td>Interface</td>
* <td>Wrap One</td>
- * <td align="middle">-</td>
+ * <td style="text-align:middle">-</td>
* <td><a href="#BridgePattern">Bridge</a><br>
* <a href="#DecoratorPattern">Decorator</a><br>
* <a href="#ProxyPattern">Proxy</a></td>
* </tr>
* <tr>
- * <td bgColor="lime"><a href="#CommandPattern">Command</a></td>
- * <td bgColor="maroon"><font color="white">Behavioral</font></td>
+ * <td style="background-color:lime"><a href="#CommandPattern">Command</a></td>
+ * <td style="background-color:maroon;color:white">Behavioral</td>
* <td>Organization or Communication of Work<br>
* Action/Response</td>
* <td>Behavior Objects</td>
@@ -95,28 +95,28 @@ public interface Glossary {
* <a href="#PrototypePattern">Prototype</a></td>
* </tr>
* <tr>
- * <td bgColor="lime"><a href="#CompositePattern">Composite</a></td>
- * <td bgColor="silver">Structural</td>
+ * <td style="background-color:lime"><a href="#CompositePattern">Composite</a></td>
+ * <td style="background-color:silver">Structural</td>
* <td>Structural Decomposition of Objects or Subsystems</td>
* <td>Wrap Many</td>
- * <td align="middle">-</td>
+ * <td style="text-align:middle">-</td>
* <td><a href="#DecoratorPattern">Decorator</a><br>
* <a href="#IteratorPattern">Iterator</a><br>
* <a href="#VisitorPattern">Visitor</a></td>
* </tr>
* <tr>
- * <td bgColor="lime"><a href="#DecoratorPattern">Decorator</a></td>
- * <td bgColor="silver">Structural</td>
+ * <td style="background-color:lime"><a href="#DecoratorPattern">Decorator</a></td>
+ * <td style="background-color:silver">Structural</td>
* <td>Instance Behavior</td>
* <td>Wrap One</td>
- * <td align="middle">-</td>
+ * <td style="text-align:middle">-</td>
* <td><a href="#ObjectAdapterPattern">Object Adapter</a><br>
* <a href="#CompositePattern">Composite</a><br>
* <a href="#StrategyPattern">Strategy</a></td>
* </tr>
* <tr>
- * <td bgColor="lime"><a href="#FacadePattern">Facade</a></td>
- * <td bgColor="silver">Structural</td>
+ * <td style="background-color:lime"><a href="#FacadePattern">Facade</a></td>
+ * <td style="background-color:silver">Structural</td>
* <td>Access Control<br>
*
* <hr>
@@ -128,63 +128,63 @@ public interface Glossary {
* <a href="#MediatorPattern">Mediator</a></td>
* </tr>
* <tr>
- * <td bgColor="lime"><a href="#FlyweightPattern">Flyweight</a></td>
- * <td bgColor="silver">Structural</td>
+ * <td style="background-color:lime"><a href="#FlyweightPattern">Flyweight</a></td>
+ * <td style="background-color:silver">Structural</td>
* <td>Shared Resource Handling</td>
* <td>Object State or Values</td>
- * <td align="middle">-</td>
+ * <td style="text-align:middle">-</td>
* <td><a href="#SingletonPattern">Singleton</a><br>
* <a href="#StatePattern">State</a><br>
* <a href="#StrategyPattern">Strategy</a><br>
* Shareable</td>
* </tr>
* <tr>
- * <td bgColor="lime"><a href="#IteratorPattern">Iterator</a></td>
- * <td bgColor="maroon"><font color="white">Behavioral</font></td>
+ * <td style="background-color:lime"><a href="#IteratorPattern">Iterator</a></td>
+ * <td style="background-color:maroon;color:white">Behavioral</td>
* <td>Traversal Algorithm<br>
*
* <hr>
* <p>Access Control</td>
* <td>Low Coupling</td>
- * <td align="middle">-</td>
+ * <td style="text-align:middle">-</td>
* <td><a href="#CompositePattern">Composite</a><br>
* <a href="#FactoryMethodPattern">Factory Method</a><br>
* <a href="#MementoPattern">Memento</a></td>
* </tr>
* <tr>
- * <td bgColor="lime"><a href="#ObserverPattern">Observer</a></td>
- * <td bgColor="maroon"><font color="white">Behavioral</font></td>
+ * <td style="background-color:lime"><a href="#ObserverPattern">Observer</a></td>
+ * <td style="background-color:maroon;color:white">Behavioral</td>
* <td>Event Response<br>
*
* <hr>
* <p>Organization or Communication of Work</td>
* <td>Low Coupling</td>
- * <td align="middle">-</td>
+ * <td style="text-align:middle">-</td>
* <td><a href="#MediatorPattern">Mediator</a><br>
* <a href="#SingletonPattern">Singleton</a></td>
* </tr>
* <tr>
- * <td bgColor="lime"><a href="#ProxyPattern">Proxy</a></td>
- * <td bgColor="silver">Structural</td>
+ * <td style="background-color:lime"><a href="#ProxyPattern">Proxy</a></td>
+ * <td style="background-color:silver">Structural</td>
* <td>Access Control</td>
* <td>Wrap One</td>
- * <td align="middle">-</td>
+ * <td style="text-align:middle">-</td>
* <td><a href="#ObjectAdapterPattern">Adapter</a><br>
* <a href="#DecoratorPattern">Decorator</a></td>
* </tr>
* <tr>
- * <td bgColor="lime"><a href="#SingletonPattern">Singleton</a></td>
- * <td bgColor="teal"><font color="white">Creational</font></td>
+ * <td style="background-color:lime"><a href="#SingletonPattern">Singleton</a></td>
+ * <td style="background-color:teal;color:white">Creational</td>
* <td>Access Control</td>
* <td>Other</td>
- * <td align="middle">-</td>
+ * <td style="text-align:middle">-</td>
* <td><a href="#AbstractFactoryPattern">Abstract Factory</a><br>
* <a href="#BuilderPattern">Builder</a><br>
* <a href="#PrototypePattern">Prototype</a></td>
* </tr>
* <tr>
- * <td bgColor="lime"><a href="#StatePattern">State</a></td>
- * <td bgColor="maroon"><font color="white">Behavioral</font></td>
+ * <td style="background-color:lime"><a href="#StatePattern">State</a></td>
+ * <td style="background-color:maroon;color:white">Behavioral</td>
* <td>Instance Behavior</td>
* <td>Object State or Values</td>
* <td><a href="#FlyweightPattern">Flyweight</a></td>
@@ -192,70 +192,70 @@ public interface Glossary {
* <a href="#SingletonPattern">Singleton</a></td>
* </tr>
* <tr>
- * <td bgColor="lime"><a href="#StrategyPattern">Strategy</a></td>
- * <td bgColor="maroon"><font color="white">Behavioral</font></td>
+ * <td style="background-color:lime"><a href="#StrategyPattern">Strategy</a></td>
+ * <td style="background-color:maroon;color:white">Behavioral</td>
* <td>Single Algorithm</td>
* <td>Behavior Objects</td>
- * <td align="middle">-</td>
+ * <td style="text-align:middle">-</td>
* <td><a href="#FlyweightPattern">Flyweight</a><br>
* <a href="#StatePattern">State</a><br>
* <a href="#TemplateMethodPattern">Template Method</a></td>
* </tr>
* <tr>
- * <td bgColor="lime"><a href="#TemplateMethodPattern">Template Method</a>
+ * <td style="background-color:lime"><a href="#TemplateMethodPattern">Template Method</a>
* </td>
- * <td bgColor="maroon"><font color="white">Behavioral</font></td>
+ * <td style="background-color:maroon;color:white">Behavioral</td>
* <td>Single Algorithm</td>
* <td>Class or Interface Definition plus Inheritance</td>
- * <td align="middle">-</td>
+ * <td style="text-align:middle">-</td>
* <td><a href="#StrategyPattern">Strategy</a></td>
* </tr>
* <!-- Moderately use patterns have a yellow background -->
* <tr>
- * <td bgColor="yellow"><a href="#ClassAdapterPattern">Class Adapter</a>
+ * <td style="background-color:yellow"><a href="#ClassAdapterPattern">Class Adapter</a>
* </td>
- * <td bgColor="silver">Structural</td>
+ * <td style="background-color:silver">Structural</td>
* <td>Interface</td>
* <td>Class or Interface Definition plus Inheritance</td>
- * <td align="middle">-</td>
+ * <td style="text-align:middle">-</td>
* <td><a href="#BridgePattern">Bridge</a><br>
* <a href="#DecoratorPattern">Decorator</a><br>
* <a href="#ProxyPattern">Proxy</a></td>
* </tr>
* <tr>
- * <td bgColor="yellow"><a href="#BridgePattern">Bridge</a></td>
- * <td bgColor="silver">Structural</td>
+ * <td style="background-color:yellow"><a href="#BridgePattern">Bridge</a></td>
+ * <td style="background-color:silver">Structural</td>
* <td>Implementation</td>
* <td>Wrap One</td>
- * <td align="middle">-</td>
+ * <td style="text-align:middle">-</td>
* <td><a href="#AbstractFactoryPattern">Abstract Factory</a><br>
* <a href="#ClassAdapterPattern">Class Adaptor</a></td>
* </tr>
* <tr>
- * <td bgColor="yellow"><a href="#BuilderPattern">Builder</a></td>
- * <td bgColor="teal"><font color="white">Creational</font></td>
+ * <td style="background-color:yellow"><a href="#BuilderPattern">Builder</a></td>
+ * <td style="background-color:teal;color:white">Creational</td>
* <td>Creating Structures</td>
* <td>Class or Interface Definition plus Inheritance</td>
- * <td align="middle">-</td>
+ * <td style="text-align:middle">-</td>
* <td><a href="#AbstractFactoryPattern">Abstract Factory</a><br>
* <a href="#CompositePattern">Composite</a></td>
* </tr>
* <tr>
- * <td bgColor="yellow"><a href="#ChainOfResponsibilityPattern">Chain of
+ * <td style="background-color:yellow"><a href="#ChainOfResponsibilityPattern">Chain of
* Responsibility</a></td>
- * <td bgColor="maroon"><font color="white">Behavioral</font></td>
+ * <td style="background-color:maroon;color:white">Behavioral</td>
* <td>Single Algorithm<br>
*
* <hr>
* <p>Organization or Communication of Work</td>
* <td>Low Coupling</td>
- * <td align="middle">-</td>
+ * <td style="text-align:middle">-</td>
* <td><a href="#CompositePattern">Composite</a></td>
* </tr>
* <tr>
- * <td bgColor="yellow"><a href="#FactoryMethodPattern">Factory Method</a>
+ * <td style="background-color:yellow"><a href="#FactoryMethodPattern">Factory Method</a>
* </td>
- * <td bgColor="teal"><font color="white">Creational</font></td>
+ * <td style="background-color:teal;color:white">Creational</td>
* <td>Creating Instances</td>
* <td>Class or Interface Definition plus Inheritance</td>
* <td><a href="#TemplateMethodPattern">Template Method</a></td>
@@ -264,56 +264,56 @@ public interface Glossary {
* <a href="#PrototypePattern">Prototype</a></td>
* </tr>
* <tr>
- * <td bgColor="yellow"><a href="#MediatorPattern">Mediator</a></td>
- * <td bgColor="maroon"><font color="white">Behavioral</font></td>
+ * <td style="background-color:yellow"><a href="#MediatorPattern">Mediator</a></td>
+ * <td style="background-color:maroon;color:white">Behavioral</td>
* <td>Interaction between Objects<br>
*
* <hr>
* <p>Organization or Communication of Work</td>
* <td>Low Coupling</td>
- * <td align="middle">-</td>
+ * <td style="text-align:middle">-</td>
* <td><a href="#FacadePattern">Facade</a><br>
* <a href="#ObserverPattern">Observer</a></td>
* </tr>
* <tr>
- * <td bgColor="yellow"><a href="#PrototypePattern">Prototype</a></td>
- * <td bgColor="teal"><font color="white">Creational</font></td>
+ * <td style="background-color:yellow"><a href="#PrototypePattern">Prototype</a></td>
+ * <td style="background-color:teal;color:white">Creational</td>
* <td>Creating Instances</td>
* <td>Other</td>
- * <td align="middle">-</td>
+ * <td style="text-align:middle">-</td>
* <td><a href="#PrototypePattern">Prototype</a><br>
* <a href="#CompositePattern">Composite</a><br>
* <a href="#DecoratorPattern">Decorator</a></td>
* </tr>
* <tr>
- * <td bgColor="yellow"><a href="#VisitorPattern">Visitor</a></td>
- * <td bgColor="maroon"><font color="white">Behavioral</font></td>
+ * <td style="background-color:yellow"><a href="#VisitorPattern">Visitor</a></td>
+ * <td style="background-color:maroon;color:white">Behavioral</td>
* <td>Single Algorithm</td>
* <td>Behavior Objects</td>
- * <td align="middle">-</td>
+ * <td style="text-align:middle">-</td>
* <td><a href="#CompositePattern">Composite</a><br>
* <a href="#VisitorPattern">Visitor</a></td>
* </tr>
* <!-- Seldom used patterns have a red background -->
* <tr>
- * <td bgColor="red"><a href="#InterpreterPattern"><font color="white">
- * Interpreter</font></a></td>
- * <td bgColor="maroon"><font color="white">Behavioral</font></td>
+ * <td style="background-color:red;color:white"><a href="#InterpreterPattern">
+ * Interpreter</a></td>
+ * <td style="background-color:maroon;color:white">Behavioral</td>
* <td>Organization or Communication of Work</td>
* <td>Other</td>
- * <td align="middle">-</td>
+ * <td style="text-align:middle">-</td>
* <td><a href="#CompositePattern">Composite</a><br>
* <a href="#FlyweightPattern">Flyweight</a><br>
* <a href="#IteratorPattern">Iterator</a><br>
* <a href="#VisitorPattern">Visitor</a></td>
* </tr>
* <tr>
- * <td bgColor="red"><a href="#MementoPattern"><font color="white">
- * Memento</font></a></td>
- * <td bgColor="maroon"><font color="white">Behavioral</font></td>
+ * <td style="background-color:red;color:white"><a href="#MementoPattern">
+ * Memento</a></td>
+ * <td style="background-color:maroon;color:white">Behavioral</td>
* <td>Instance Management</td>
* <td>Object State or Values</td>
- * <td align="middle">-</td>
+ * <td style="text-align:middle">-</td>
* <td><a href="#CommandPattern">Command</a><br>
* <a href="#IteratorPattern">Iterator</a></td>
* </tr>
http://git-wip-us.apache.org/repos/asf/calcite/blob/03dce133/core/src/test/java/org/apache/calcite/test/concurrent/package-info.java
----------------------------------------------------------------------
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 317a030..84d1813 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
@@ -247,7 +247,7 @@
*
* <p>The output from each thread is stored in a temporary file until
* the test completes. At that point, the files are merged together
- * into a single <tt>.log</tt> file containing the results of each
+ * into a single <code>.log</code> file containing the results of each
* thread, in the order the threads were defined. The output for the
* example script looks like:
*
http://git-wip-us.apache.org/repos/asf/calcite/blob/03dce133/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index c934449..365f41e 100644
--- a/pom.xml
+++ b/pom.xml
@@ -106,8 +106,8 @@ limitations under the License.
<maven-checkstyle-plugin.version>3.0.0</maven-checkstyle-plugin.version>
<maven-dependency-plugin.version>2.10</maven-dependency-plugin.version>
<maven-enforcer-plugin.version>3.0.0-M1</maven-enforcer-plugin.version>
- <!-- Apache 19 has 2.10.4, but need 3.0.0 for [LANG-1365]. -->
- <maven-javadoc-plugin.version>3.0.0</maven-javadoc-plugin.version>
+ <!-- Apache 19 has 2.10.4, but need 3.0.1 for [LANG-1365] and [MJAVADOC-517]. -->
+ <maven-javadoc-plugin.version>3.0.1</maven-javadoc-plugin.version>
<maven-scm-provider.version>1.9.4</maven-scm-provider.version>
<maven-shade-plugin.version>2.1</maven-shade-plugin.version>
<!-- Apache 19 has 2.20.1, but need 2.21.0+ for [MPOM-184] -->