You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@inlong.apache.org by do...@apache.org on 2022/05/24 12:20:02 UTC
[incubator-inlong] branch master updated: [INLONG-4349][Doc] Update check style to avoid the Javadoc missing and error (#4350)
This is an automated email from the ASF dual-hosted git repository.
dockerzhang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-inlong.git
The following commit(s) were added to refs/heads/master by this push:
new 93da787da [INLONG-4349][Doc] Update check style to avoid the Javadoc missing and error (#4350)
93da787da is described below
commit 93da787da615aba953741d6502f6f11044e132da
Author: dockerzhang <do...@apache.org>
AuthorDate: Tue May 24 20:19:56 2022 +0800
[INLONG-4349][Doc] Update check style to avoid the Javadoc missing and error (#4350)
---
codestyle/checkstyle.xml | 20 +++++++++++++-------
.../inlong/agent/metrics/meta/MetricsMeta.java | 2 +-
.../service/resource/es/ElasticsearchApi.java | 3 ++-
.../standalone/sink/cls/IEvent2LogItemHandler.java | 2 +-
.../apache/inlong/sort/cdc/mysql/MySqlSource.java | 4 ++--
.../sort/cdc/mysql/source/utils/RecordUtils.java | 2 +-
.../inlong/tubemq/corebase/utils/TStringUtils.java | 2 +-
7 files changed, 21 insertions(+), 14 deletions(-)
diff --git a/codestyle/checkstyle.xml b/codestyle/checkstyle.xml
index d81a80040..79628667c 100644
--- a/codestyle/checkstyle.xml
+++ b/codestyle/checkstyle.xml
@@ -371,13 +371,13 @@
<property name="severity" value="ignore"/>
</module>
<module name="InvalidJavadocPosition">
- <property name="severity" value="info"/>
+ <property name="severity" value="error"/>
+ </module>
+ <module name="JavadocTagContinuationIndentation">
+ <property name="severity" value="error"/>
</module>
- <!-- new add
- <module name="JavadocTagContinuationIndentation"/>
- -->
<module name="SummaryJavadoc">
- <property name="severity" value="info"/>
+ <property name="severity" value="error"/>
<property name="forbiddenSummaryFragments"
value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
<!--
@@ -396,7 +396,7 @@
</module>
-->
<module name="JavadocMethod">
- <property name="severity" value="info"/>
+ <property name="severity" value="error"/>
<property name="scope" value="public"/>
<property name="allowMissingParamTags" value="true"/>
<property name="allowMissingReturnTag" value="true"/>
@@ -419,9 +419,15 @@
</module>
<module name="SingleLineJavadoc">
- <property name="severity" value="info"/>
+ <property name="severity" value="error"/>
<property name="ignoreInlineTags" value="true"/>
</module>
+ <!--
+ <module name="MissingJavadocMethod">
+ <property name="severity" value="info"/>
+ <property name="scope" value="public"/>
+ </module>
+ -->
<module name="EmptyCatchBlock">
<property name="exceptionVariableName" value="expected"/>
</module>
diff --git a/inlong-agent/agent-common/src/main/java/org/apache/inlong/agent/metrics/meta/MetricsMeta.java b/inlong-agent/agent-common/src/main/java/org/apache/inlong/agent/metrics/meta/MetricsMeta.java
index c37c8cd18..a06d5033f 100644
--- a/inlong-agent/agent-common/src/main/java/org/apache/inlong/agent/metrics/meta/MetricsMeta.java
+++ b/inlong-agent/agent-common/src/main/java/org/apache/inlong/agent/metrics/meta/MetricsMeta.java
@@ -35,7 +35,7 @@ public class MetricsMeta {
}
/**
- * build metricsMeta based on {@link Metrics} and {@link List<MetricMeta>} params
+ * build metricsMeta based on {@link Metrics} and the {@link List} of {@link MetricMeta} params
*/
public static MetricsMeta build(Metrics metrics,
List<MetricMeta> metricMetaList) {
diff --git a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/resource/es/ElasticsearchApi.java b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/resource/es/ElasticsearchApi.java
index a95d3de52..44f5e6322 100644
--- a/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/resource/es/ElasticsearchApi.java
+++ b/inlong-manager/manager-service/src/main/java/org/apache/inlong/manager/service/resource/es/ElasticsearchApi.java
@@ -169,7 +169,8 @@ public class ElasticsearchApi {
* Get fields
*
* @param indexName The index name of Elasticsearch
- * @return Map<String, MappingMetaData> index information
+ * @return a {@link Map} collection that contains {@link String}
+ * as key and {@link MappingMetaData} as value.
* @throws IOException The exception may throws
*/
public Map<String, MappingMetaData> getFields(String indexName) throws IOException {
diff --git a/inlong-sort-standalone/sort-standalone-source/src/main/java/org/apache/inlong/sort/standalone/sink/cls/IEvent2LogItemHandler.java b/inlong-sort-standalone/sort-standalone-source/src/main/java/org/apache/inlong/sort/standalone/sink/cls/IEvent2LogItemHandler.java
index 7633d84ed..d29937118 100644
--- a/inlong-sort-standalone/sort-standalone-source/src/main/java/org/apache/inlong/sort/standalone/sink/cls/IEvent2LogItemHandler.java
+++ b/inlong-sort-standalone/sort-standalone-source/src/main/java/org/apache/inlong/sort/standalone/sink/cls/IEvent2LogItemHandler.java
@@ -32,7 +32,7 @@ public interface IEvent2LogItemHandler {
*
* @param context Context of CLS sink.
* @param event Event to be pares to {@literal List<LogItem>}
- * @return {@link List<LogItem>}
+ * @return {@literal List<LogItem>}
*/
List<LogItem> parse(ClsSinkContext context, ProfileEvent event);
}
diff --git a/inlong-sort/sort-connectors/mysql-cdc/src/main/java/org/apache/inlong/sort/cdc/mysql/MySqlSource.java b/inlong-sort/sort-connectors/mysql-cdc/src/main/java/org/apache/inlong/sort/cdc/mysql/MySqlSource.java
index 721de08f3..cfc1fecd9 100644
--- a/inlong-sort/sort-connectors/mysql-cdc/src/main/java/org/apache/inlong/sort/cdc/mysql/MySqlSource.java
+++ b/inlong-sort/sort-connectors/mysql-cdc/src/main/java/org/apache/inlong/sort/cdc/mysql/MySqlSource.java
@@ -36,7 +36,7 @@ import static org.apache.inlong.sort.cdc.debezium.DebeziumSourceFunction.LEGACY_
* A builder to build a SourceFunction which can read snapshot and continue to consume binlog.
*
* @deprecated please use {@link org.apache.inlong.sort.cdc.mysql.source.MySqlSource} instead
- * which supports more rich features, e.g. parallel reading from historical data. The {@link
+ * which supports more rich features, e.g. parallel reading from historical data. The {@link
* MySqlSource} will be dropped in the future version.
*/
@Deprecated
@@ -53,7 +53,7 @@ public class MySqlSource {
*
* @deprecated please use {@link
* org.apache.inlong.sort.cdc.mysql.source.MySqlSource#builder()} instead which supports
- * more rich features, e.g. parallel reading from historical data. The {@link
+ * more rich features, e.g. parallel reading from historical data. The {@link
* Builder} will be dropped in the future version.
*/
@Deprecated
diff --git a/inlong-sort/sort-connectors/mysql-cdc/src/main/java/org/apache/inlong/sort/cdc/mysql/source/utils/RecordUtils.java b/inlong-sort/sort-connectors/mysql-cdc/src/main/java/org/apache/inlong/sort/cdc/mysql/source/utils/RecordUtils.java
index 5e944c828..e1cca0a27 100644
--- a/inlong-sort/sort-connectors/mysql-cdc/src/main/java/org/apache/inlong/sort/cdc/mysql/source/utils/RecordUtils.java
+++ b/inlong-sort/sort-connectors/mysql-cdc/src/main/java/org/apache/inlong/sort/cdc/mysql/source/utils/RecordUtils.java
@@ -315,7 +315,7 @@ public class RecordUtils {
* Return the finished snapshot split information.
*
* @return [splitId, splitStart, splitEnd, highWatermark], the information will be used to
- * filter binlog events when read binlog of table.
+ * filter binlog events when read binlog of table.
*/
public static FinishedSnapshotSplitInfo getSnapshotSplitInfo(
MySqlSnapshotSplit split, SourceRecord highWatermark) {
diff --git a/inlong-tubemq/tubemq-core/src/main/java/org/apache/inlong/tubemq/corebase/utils/TStringUtils.java b/inlong-tubemq/tubemq-core/src/main/java/org/apache/inlong/tubemq/corebase/utils/TStringUtils.java
index 6fbf149a2..05bfb87e4 100644
--- a/inlong-tubemq/tubemq-core/src/main/java/org/apache/inlong/tubemq/corebase/utils/TStringUtils.java
+++ b/inlong-tubemq/tubemq-core/src/main/java/org/apache/inlong/tubemq/corebase/utils/TStringUtils.java
@@ -82,7 +82,7 @@ public class TStringUtils {
*
* @param origStr The string to be converted
* @return Convert the string to Camel Case
- * if it is <code>null</code>, return<code>null</code>
+ * if it is <code>null</code>, return<code>null</code>
*/
public static String toCamelCase(String origStr) {
if (isEmpty(origStr)) {