You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@calcite.apache.org by vl...@apache.org on 2019/11/10 20:33:04 UTC

[calcite-avatica] 02/02: Add source=1.8 to javadoc options, fix javadoc warnings

This is an automated email from the ASF dual-hosted git repository.

vladimirsitnikov pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/calcite-avatica.git

commit 5a514d668336e1bde0b5a23dc4243a1ac00e6ff4
Author: Vladimir Sitnikov <si...@gmail.com>
AuthorDate: Sun Nov 10 23:31:09 2019 +0300

    Add source=1.8 to javadoc options, fix javadoc warnings
    
    It prevents javadoc: error - The code being documented uses modules but the packages
---
 build.gradle.kts                                                       | 3 +++
 .../main/java/org/apache/calcite/avatica/metrics/MetricsSystem.java    | 1 +
 .../java/org/apache/calcite/avatica/metrics/MetricsSystemFactory.java  | 1 +
 3 files changed, 5 insertions(+)

diff --git a/build.gradle.kts b/build.gradle.kts
index 2a1c9a5..8d7cda8 100644
--- a/build.gradle.kts
+++ b/build.gradle.kts
@@ -216,6 +216,9 @@ allprojects {
             (options as StandardJavadocDocletOptions).apply {
                 noTimestamp.value = true
                 showFromProtected()
+                // javadoc: error - The code being documented uses modules but the packages
+                // defined in https://docs.oracle.com/javase/9/docs/api/ are in the unnamed module
+                source = "1.8"
                 docEncoding = "UTF-8"
                 charSet = "UTF-8"
                 encoding = "UTF-8"
diff --git a/metrics/src/main/java/org/apache/calcite/avatica/metrics/MetricsSystem.java b/metrics/src/main/java/org/apache/calcite/avatica/metrics/MetricsSystem.java
index 0d1cb4b..a05f79c 100644
--- a/metrics/src/main/java/org/apache/calcite/avatica/metrics/MetricsSystem.java
+++ b/metrics/src/main/java/org/apache/calcite/avatica/metrics/MetricsSystem.java
@@ -60,6 +60,7 @@ public interface MetricsSystem {
    *
    * @param name The name of the Gauge.
    * @param gauge A callback to compute the current value.
+   * @param <T> The type of the Gauge.
    */
   <T> void register(String name, Gauge<T> gauge);
 
diff --git a/metrics/src/main/java/org/apache/calcite/avatica/metrics/MetricsSystemFactory.java b/metrics/src/main/java/org/apache/calcite/avatica/metrics/MetricsSystemFactory.java
index 484b230..97a5587 100644
--- a/metrics/src/main/java/org/apache/calcite/avatica/metrics/MetricsSystemFactory.java
+++ b/metrics/src/main/java/org/apache/calcite/avatica/metrics/MetricsSystemFactory.java
@@ -24,6 +24,7 @@ public interface MetricsSystemFactory {
   /**
    * Creates an instance of a {@link MetricsSystem}.
    *
+   * @param config the metrics system configuration.
    * @return A new {@link MetricsSystem}.
    */
   MetricsSystem create(MetricsSystemConfiguration<?> config);