fix javadocs problem and add check

Author: liubao68

.github/workflows/javadoc.yml

@@ -0,0 +1,38 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+name: javadoc
+on:
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  javadoc:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up jdk
+        uses: actions/setup-java@v4
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+      - name: javadoc
+        run: mvn javadoc:javadoc -Prelease

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);

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";

core/src/main/java/org/apache/servicecomb/core/invocation/endpoint/EndpointUtils.java

@@ -88,7 +88,7 @@ public static Endpoint parse(String uriEndpoint) {
   }
 
   /**
-   * <pre>
+   * {@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
-   * </pre>
+   * }
    *
    *  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.

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>
+   * <p>
+   *{@code
    * List<GenericObjectParam<List<RecursiveObjectParam>>> response = consumers.getSCBRestTemplate()
    * postForObject("/testListObjectParam", request, List.class);
-   * </code>
+   * }
    *
    * should work for versions of 1.*. This is because java-chassis can read type info from swaggers.
-   *
+   * <p>
    * Start from 2.x, the best practise to write this code is to use ParameterizedTypeReference provided by RestTemplate
    * exchange method.
    */

foundations/foundation-registry/src/main/java/org/apache/servicecomb/registry/api/Registration.java

@@ -22,42 +22,42 @@
 
 
 /**
- * This is the core service registration interface. <br/>
+ * This is the core service registration interface.
  */
 public interface Registration<R extends RegistrationInstance> extends SPIEnabled, SPIOrder, LifeCycle {
   String name();
 
   /**
-   * get MicroserviceInstance </br>
-   *
+   * get MicroserviceInstance
+   * <p>
    * Life Cycle：This method is called anytime after <code>run</code>.
    */
   R getMicroserviceInstance();
 
   /**
-   * update MicroserviceInstance status </br>
-   *
+   * update MicroserviceInstance status
+   * <p>
    * Life Cycle：This method is called anytime after <code>run</code>.
    */
   boolean updateMicroserviceInstanceStatus(MicroserviceInstanceStatus status);
 
   /**
-   * adding schemas to Microservice </br>
-   *
+   * adding schemas to Microservice
+   * <p>
    * Life Cycle：This method is called after <code>init</code> and before <code>run</code>.
    */
   void addSchema(String schemaId, String content);
 
   /**
-   * adding endpoints to MicroserviceInstance </br>
-   *
+   * adding endpoints to MicroserviceInstance
+   * <p>
    * Life Cycle：This method is called after <code>init</code> and before <code>run</code>.
    */
   void addEndpoint(String endpoint);
 
   /**
-   * adding property to MicroserviceInstance </br>
-   *
+   * adding property to MicroserviceInstance
+   * <p>
    * Life Cycle：This method is called after <code>init</code> and before <code>run</code>.
    */
   void addProperty(String key, String value);

governance/src/main/java/org/apache/servicecomb/governance/marker/operator/CompareOperator.java

@@ -38,7 +38,7 @@ public String name() {
   }
 
   /**
-   * 支持 > < = >= <= ! 后面加数字
+   * 支持 {@code > < = >= <= !} 后面加数字
    *
    * @param targetStr
    * @param patternStr

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<INSTANCE> {
 

governance/src/main/java/org/apache/servicecomb/router/exception/RouterIllegalParamException.java

@@ -17,8 +17,8 @@
 package org.apache.servicecomb.router.exception;
 
 /**
- * @Author GuoYl123
- * @Date 2019/11/4
+ * @author GuoYl123
+ * @since 2019/11/4
  **/
 public class RouterIllegalParamException extends RuntimeException {
 

governance/src/main/java/org/apache/servicecomb/router/model/HeaderRule.java

@@ -21,8 +21,8 @@
 import org.slf4j.LoggerFactory;
 
 /**
- * @Author GuoYl123
- * @Date 2019/10/17
+ * @author GuoYl123
+ * @since 2019/10/17
  **/
 public class HeaderRule {