diff --git a/.github/workflows/checkstyle.yml b/.github/workflows/checkstyle.yml index 9b153e77a3e..2accac178fe 100644 --- a/.github/workflows/checkstyle.yml +++ b/.github/workflows/checkstyle.yml @@ -36,3 +36,5 @@ jobs: distribution: 'temurin' - name: checkstyle run: mvn -B -Pit install -DskipTests -Dspotbugs.skip=true checkstyle:check + - name: javadoc + run: mvn javadoc:javadoc -Prelease diff --git a/clients/service-center-client/src/main/java/org/apache/servicecomb/service/center/client/ServiceCenterOperation.java b/clients/service-center-client/src/main/java/org/apache/servicecomb/service/center/client/ServiceCenterOperation.java index 85671fee9c9..c80e4933a0a 100644 --- a/clients/service-center-client/src/main/java/org/apache/servicecomb/service/center/client/ServiceCenterOperation.java +++ b/clients/service-center-client/src/main/java/org/apache/servicecomb/service/center/client/ServiceCenterOperation.java @@ -160,7 +160,6 @@ boolean updateMicroserviceInstanceStatus(String serviceId, String instanceId, * Batch send heartbeats to service-center * * @param heartbeatsRequest - * @return * @throws OperationException */ void sendHeartBeats(HeartbeatsRequest heartbeatsRequest); diff --git a/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/query/QueryCodecMulti.java b/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/query/QueryCodecMulti.java index 551ccee01ae..4c2f4287916 100644 --- a/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/query/QueryCodecMulti.java +++ b/common/common-rest/src/main/java/org/apache/servicecomb/common/rest/codec/query/QueryCodecMulti.java @@ -25,9 +25,6 @@ import jakarta.servlet.http.HttpServletRequest; -/** - * ?query=x1&query=x2 - */ @SuppressWarnings("unchecked") public class QueryCodecMulti extends AbstractQueryCodec { public static final String CODEC_NAME = "form:1"; diff --git a/core/src/main/java/org/apache/servicecomb/core/invocation/endpoint/EndpointUtils.java b/core/src/main/java/org/apache/servicecomb/core/invocation/endpoint/EndpointUtils.java index d906de63ba5..2d8b37c997a 100644 --- a/core/src/main/java/org/apache/servicecomb/core/invocation/endpoint/EndpointUtils.java +++ b/core/src/main/java/org/apache/servicecomb/core/invocation/endpoint/EndpointUtils.java @@ -88,7 +88,7 @@ public static Endpoint parse(String uriEndpoint) { } /** - *
+ * {@code
* http://xxx -> rest://xxx
* https://xxx -> rest://xxx?sslEnabled=true
*
@@ -98,7 +98,7 @@ public static Endpoint parse(String uriEndpoint) {
* xxx -> rest://xxx:port?protocol=http2
* xxx?a=a1 -> rest://xxx:port?a=a1&protocol=http2
* other://xxx -> other://xxx
- *
+ * }
*
* This method provided for convenience of handling user input endpoints, and do not have a strict meaning. Make sure all unit test cases
* work before change.
diff --git a/foundations/foundation-common/src/main/java/org/apache/servicecomb/foundation/common/utils/GenericsUtils.java b/foundations/foundation-common/src/main/java/org/apache/servicecomb/foundation/common/utils/GenericsUtils.java
index 0429b82da70..d872236082e 100644
--- a/foundations/foundation-common/src/main/java/org/apache/servicecomb/foundation/common/utils/GenericsUtils.java
+++ b/foundations/foundation-common/src/main/java/org/apache/servicecomb/foundation/common/utils/GenericsUtils.java
@@ -24,14 +24,14 @@ public final class GenericsUtils {
/**
* check if XXX.class is generic type. see TestGenericsUtils for details meaning.
* This method is provided for API compatibility for RestTemplate. Following code:
- *
- *
+ *
+ *{@code
* List>> response = consumers.getSCBRestTemplate()
* postForObject("/testListObjectParam", request, List.class);
- *
+ * }
*
* should work for versions of 1.*. This is because java-chassis can read type info from swaggers.
- *
+ *
* Start from 2.x, the best practise to write this code is to use ParameterizedTypeReference provided by RestTemplate
* exchange method.
*/
diff --git a/foundations/foundation-registry/src/main/java/org/apache/servicecomb/registry/api/Registration.java b/foundations/foundation-registry/src/main/java/org/apache/servicecomb/registry/api/Registration.java
index c5529619f56..014da5f147b 100644
--- a/foundations/foundation-registry/src/main/java/org/apache/servicecomb/registry/api/Registration.java
+++ b/foundations/foundation-registry/src/main/java/org/apache/servicecomb/registry/api/Registration.java
@@ -22,42 +22,42 @@
/**
- * This is the core service registration interface.
* Life Cycle:This method is called anytime after
* Life Cycle:This method is called anytime after
* Life Cycle:This method is called after
* Life Cycle:This method is called after
* Life Cycle:This method is called after
+ * This is the core service registration interface.
*/
public interface Registrationrun.
*/
R getMicroserviceInstance();
/**
- * update MicroserviceInstance status
- *
+ * update MicroserviceInstance status
+ * run.
*/
boolean updateMicroserviceInstanceStatus(MicroserviceInstanceStatus status);
/**
- * adding schemas to Microservice
- *
+ * adding schemas to Microservice
+ * init and before run.
*/
void addSchema(String schemaId, String content);
/**
- * adding endpoints to MicroserviceInstance
- *
+ * adding endpoints to MicroserviceInstance
+ * init and before run.
*/
void addEndpoint(String endpoint);
/**
- * adding property to MicroserviceInstance
- *
+ * adding property to MicroserviceInstance
+ * init and before run.
*/
void addProperty(String key, String value);
diff --git a/governance/src/main/java/org/apache/servicecomb/governance/marker/operator/CompareOperator.java b/governance/src/main/java/org/apache/servicecomb/governance/marker/operator/CompareOperator.java
index 5379bf8c24c..5b73b9aa939 100644
--- a/governance/src/main/java/org/apache/servicecomb/governance/marker/operator/CompareOperator.java
+++ b/governance/src/main/java/org/apache/servicecomb/governance/marker/operator/CompareOperator.java
@@ -38,7 +38,7 @@ public String name() {
}
/**
- * 支持 > < = >= <= ! 后面加数字
+ * 支持 {@code > < = >= <= !} 后面加数字
*
* @param targetStr
* @param patternStr
diff --git a/governance/src/main/java/org/apache/servicecomb/router/distribute/RouterDistributor.java b/governance/src/main/java/org/apache/servicecomb/router/distribute/RouterDistributor.java
index fa9af8fd16f..5f5babdec34 100644
--- a/governance/src/main/java/org/apache/servicecomb/router/distribute/RouterDistributor.java
+++ b/governance/src/main/java/org/apache/servicecomb/router/distribute/RouterDistributor.java
@@ -23,8 +23,8 @@
import org.apache.servicecomb.router.model.PolicyRuleItem;
/**
- * @Author GuoYl123
- * @Date 2019/10/17
+ * @author GuoYl123
+ * @since 2019/10/17
**/
public interface RouterDistributor