You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ignite.apache.org by am...@apache.org on 2021/07/22 14:46:29 UTC
[ignite-3] branch main updated: IGNITE-15173: Fix javadoc in
Calcite module. (#239)
This is an automated email from the ASF dual-hosted git repository.
amashenkov pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/ignite-3.git
The following commit(s) were added to refs/heads/main by this push:
new 151475e IGNITE-15173: Fix javadoc in Calcite module. (#239)
151475e is described below
commit 151475e6f9061d3bf84b43287e84724dcf3b9625
Author: ygerzhedovich <41...@users.noreply.github.com>
AuthorDate: Thu Jul 22 17:46:19 2021 +0300
IGNITE-15173: Fix javadoc in Calcite module. (#239)
---
check-rules/checkstyle-disabled-modules.xml | 1 -
.../java/org/apache/calcite/plan/volcano/VolcanoUtils.java | 9 +++++++--
.../plan/volcano/{VolcanoUtils.java => package-info.java} | 13 +++----------
3 files changed, 10 insertions(+), 13 deletions(-)
diff --git a/check-rules/checkstyle-disabled-modules.xml b/check-rules/checkstyle-disabled-modules.xml
index 07a397c..117bdad 100644
--- a/check-rules/checkstyle-disabled-modules.xml
+++ b/check-rules/checkstyle-disabled-modules.xml
@@ -24,7 +24,6 @@
<!-- To be removed once all javadoc issues will be fixed. -->
<suppressions>
<suppress files="[/\\]examples[/\\]" checks=".*" />
- <suppress files="[/\\]modules/calcite[/\\]" checks=".*" />
<suppress files="[/\\]modules/cli[/\\]" checks=".*" />
<suppress files="[/\\]modules/configuration-api[/\\]" checks=".*" />
<suppress files="[/\\]modules/raft-client[/\\]" checks=".*" />
diff --git a/modules/calcite/src/main/java/org/apache/calcite/plan/volcano/VolcanoUtils.java b/modules/calcite/src/main/java/org/apache/calcite/plan/volcano/VolcanoUtils.java
index 185d453..b7d6913 100644
--- a/modules/calcite/src/main/java/org/apache/calcite/plan/volcano/VolcanoUtils.java
+++ b/modules/calcite/src/main/java/org/apache/calcite/plan/volcano/VolcanoUtils.java
@@ -19,9 +19,14 @@ package org.apache.calcite.plan.volcano;
import org.apache.calcite.plan.RelOptCost;
-/** */
+/** Utils for access to package-private fields. */
public class VolcanoUtils {
- /** */
+ /**
+ * Return cost of best known plan.
+ *
+ * @param relSubset RelSubset.
+ * @return Cost of best known plan for given relSubset.
+ */
public static RelOptCost bestCost(RelSubset relSubset) {
return relSubset.bestCost;
}
diff --git a/modules/calcite/src/main/java/org/apache/calcite/plan/volcano/VolcanoUtils.java b/modules/calcite/src/main/java/org/apache/calcite/plan/volcano/package-info.java
similarity index 81%
copy from modules/calcite/src/main/java/org/apache/calcite/plan/volcano/VolcanoUtils.java
copy to modules/calcite/src/main/java/org/apache/calcite/plan/volcano/package-info.java
index 185d453..9566cd9 100644
--- a/modules/calcite/src/main/java/org/apache/calcite/plan/volcano/VolcanoUtils.java
+++ b/modules/calcite/src/main/java/org/apache/calcite/plan/volcano/package-info.java
@@ -15,14 +15,7 @@
* limitations under the License.
*/
+/**
+ * Contains utils for access to package-private Calcite Volcano classes.
+ */
package org.apache.calcite.plan.volcano;
-
-import org.apache.calcite.plan.RelOptCost;
-
-/** */
-public class VolcanoUtils {
- /** */
- public static RelOptCost bestCost(RelSubset relSubset) {
- return relSubset.bestCost;
- }
-}