From 46cbf22147d783fb68f77fad95161dc5ef036c96 Mon Sep 17 00:00:00 2001
From: Jacky Lau <liuyongvs@gmail.com>
Date: Fri, 1 Mar 2024 17:53:41 +0800
Subject: [PATCH] [FLINK-34492][table] Fix comment link when migrate calcite
 rules from scala to java

---
 .../plan/rules/logical/FlinkCalcMergeRule.java    | 15 +++++++++------
 .../plan/rules/logical/FlinkLimit0RemoveRule.java |  2 +-
 .../JoinTableFunctionScanToCorrelateRule.java     |  5 ++++-
 3 files changed, 14 insertions(+), 8 deletions(-)

diff --git a/flink-table/flink-table-planner/src/main/java/org/apache/flink/table/planner/plan/rules/logical/FlinkCalcMergeRule.java b/flink-table/flink-table-planner/src/main/java/org/apache/flink/table/planner/plan/rules/logical/FlinkCalcMergeRule.java
index f82a1bcf18887..61e01715b50cb 100644
--- a/flink-table/flink-table-planner/src/main/java/org/apache/flink/table/planner/plan/rules/logical/FlinkCalcMergeRule.java
+++ b/flink-table/flink-table-planner/src/main/java/org/apache/flink/table/planner/plan/rules/logical/FlinkCalcMergeRule.java
@@ -30,18 +30,21 @@
 import org.immutables.value.Value;
 
 /**
- * This rule is copied from Calcite's [[org.apache.calcite.rel.rules.CalcMergeRule]].
+ * This rule is copied from Calcite's {@link org.apache.calcite.rel.rules.CalcMergeRule}.
  *
  * <p>Modification: - Condition in the merged program will be simplified if it exists. - If the two
- * [[Calc]] can merge into one, each non-deterministic [[RexNode]] of bottom [[Calc]] should appear
- * at most once in the project list and filter list of top [[Calc]].
+ * {@link org.apache.calcite.rel.core.Calc} can merge into one, each non-deterministic {@link
+ * org.apache.calcite.rex.RexNode} of bottom {@link org.apache.calcite.rel.core.Calc} should appear
+ * at most once in the project list and filter list of top {@link org.apache.calcite.rel.core.Calc}.
  */
 
 /**
- * Planner rule that merges a [[Calc]] onto a [[Calc]].
+ * Planner rule that merges a {@link org.apache.calcite.rel.core.Calc} onto a {@link
+ * org.apache.calcite.rel.core.Calc}.
  *
- * <p>The resulting [[Calc]] has the same project list as the upper [[Calc]], but expressed in terms
- * of the lower [[Calc]]'s inputs.
+ * <p>The resulting {@link org.apache.calcite.rel.core.Calc} has the same project list as the upper
+ * {@link org.apache.calcite.rel.core.Calc}, but expressed in terms of the lower {@link
+ * org.apache.calcite.rel.core.Calc}'s inputs.
  */
 @Value.Enclosing
 public class FlinkCalcMergeRule extends RelRule<FlinkCalcMergeRule.FlinkCalcMergeRuleConfig> {
diff --git a/flink-table/flink-table-planner/src/main/java/org/apache/flink/table/planner/plan/rules/logical/FlinkLimit0RemoveRule.java b/flink-table/flink-table-planner/src/main/java/org/apache/flink/table/planner/plan/rules/logical/FlinkLimit0RemoveRule.java
index 59d2b1d95917e..bb9654f5df594 100644
--- a/flink-table/flink-table-planner/src/main/java/org/apache/flink/table/planner/plan/rules/logical/FlinkLimit0RemoveRule.java
+++ b/flink-table/flink-table-planner/src/main/java/org/apache/flink/table/planner/plan/rules/logical/FlinkLimit0RemoveRule.java
@@ -25,7 +25,7 @@
 import org.apache.calcite.rex.RexLiteral;
 import org.immutables.value.Value;
 
-/** Planner rule that rewrites `limit 0` to empty [[org.apache.calcite.rel.core.Values]]. */
+/** Planner rule that rewrites `limit 0` to empty {@link org.apache.calcite.rel.core.Values}. */
 @Value.Enclosing
 public class FlinkLimit0RemoveRule
         extends RelRule<FlinkLimit0RemoveRule.FlinkLimit0RemoveRuleConfig> {
diff --git a/flink-table/flink-table-planner/src/main/java/org/apache/flink/table/planner/plan/rules/logical/JoinTableFunctionScanToCorrelateRule.java b/flink-table/flink-table-planner/src/main/java/org/apache/flink/table/planner/plan/rules/logical/JoinTableFunctionScanToCorrelateRule.java
index d6f8752b352db..b14054906c129 100644
--- a/flink-table/flink-table-planner/src/main/java/org/apache/flink/table/planner/plan/rules/logical/JoinTableFunctionScanToCorrelateRule.java
+++ b/flink-table/flink-table-planner/src/main/java/org/apache/flink/table/planner/plan/rules/logical/JoinTableFunctionScanToCorrelateRule.java
@@ -25,7 +25,10 @@
 import org.apache.calcite.rel.logical.LogicalTableFunctionScan;
 import org.immutables.value.Value;
 
-/** Rule that rewrites Join on TableFunctionScan to Correlate. */
+/**
+ * Rule that rewrites {@link org.apache.calcite.rel.core.Join} on {@link
+ * org.apache.calcite.rel.core.TableFunctionScan} to {@link org.apache.calcite.rel.core.Correlate}.
+ */
 @Value.Enclosing
 public class JoinTableFunctionScanToCorrelateRule
         extends RelRule<JoinTableFunctionScanToCorrelateRule.Config> {