fix javadoc when release

Author: lvjing2

.github/workflows/koupleless_runtime_snapshot_2.0.x.yml

@@ -1,7 +1,7 @@
 # This workflow will build a Java project with Maven, and cache/restore any dependencies to improve the workflow execution time
 # For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven
 
-name: Koupleless Snapshot Release for 2.0.x
+name: Koupleless Runtime Snapshot for 2.0.x
 
 ## https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#release
 ## trigger manually
@@ -127,4 +127,4 @@ jobs:
         env:
           MAVEN_USERNAME: ${{ secrets.MAVEN_USERNAME }}
           MAVEN_PASSWORD: ${{ secrets.MAVEN_PASSWORD }}
-          MAVEN_GPG_PASSPHRASE: ${{ secrets.MAVEN_GPG_PASSPHRASE }}
+          MAVEN_GPG_PASSPHRASE: ${{ secrets.MAVEN_GPG_PASSPHRASE }}

.github/workflows/koupleless_runtime_snapshot_2.1.x.yml

@@ -1,7 +1,7 @@
 # This workflow will build a Java project with Maven, and cache/restore any dependencies to improve the workflow execution time
 # For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven
 
-name: Koupleless Snapshot Release for 2.1.x
+name: Koupleless Runtime Snapshot for 2.1.x
 
 ## https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#release
 ## trigger manually
@@ -128,4 +128,4 @@ jobs:
         env:
           MAVEN_USERNAME: ${{ secrets.MAVEN_USERNAME }}
           MAVEN_PASSWORD: ${{ secrets.MAVEN_PASSWORD }}
-          MAVEN_GPG_PASSPHRASE: ${{ secrets.MAVEN_GPG_PASSPHRASE }}
+          MAVEN_GPG_PASSPHRASE: ${{ secrets.MAVEN_GPG_PASSPHRASE }}

arklet-core/src/main/java/com/alipay/sofa/koupleless/arklet/core/ArkletComponent.java

@@ -19,8 +19,10 @@
 /**
  *  * Arklet component interface, managed by registry
  *  * @see ArkletComponentRegistry
+ *
  * @author mingmen
- * @date 2023/6/8
+ * @since 2023/6/8
+ * @version 1.0.0
  */
 public interface ArkletComponent {
 

arklet-core/src/main/java/com/alipay/sofa/koupleless/arklet/core/ArkletComponentRegistry.java

@@ -37,8 +37,11 @@
 import com.google.inject.multibindings.Multibinder;
 
 /**
+ * <p>ArkletComponentRegistry class.</p>
+ *
  * @author mingmen
- * @date 2023/6/14
+ * @since 2023/6/14
+ * @version 1.0.0
  */
 public class ArkletComponentRegistry {
 
@@ -75,18 +78,38 @@ private static void destroyComponents() {
         ArkletLoggerFactory.getDefaultLogger().info("finish destroy components");
     }
 
+    /**
+     * <p>getOperationServiceInstance.</p>
+     *
+     * @return a {@link com.alipay.sofa.koupleless.arklet.core.ops.UnifiedOperationService} object
+     */
     public static UnifiedOperationService getOperationServiceInstance() {
         return componentInjector.getInstance(UnifiedOperationService.class);
     }
 
+    /**
+     * <p>getCommandServiceInstance.</p>
+     *
+     * @return a {@link com.alipay.sofa.koupleless.arklet.core.command.CommandService} object
+     */
     public static CommandService getCommandServiceInstance() {
         return componentInjector.getInstance(CommandService.class);
     }
 
+    /**
+     * <p>getHealthServiceInstance.</p>
+     *
+     * @return a {@link com.alipay.sofa.koupleless.arklet.core.health.HealthService} object
+     */
     public static HealthService getHealthServiceInstance() {
         return componentInjector.getInstance(HealthService.class);
     }
 
+    /**
+     * <p>getApiClientInstance.</p>
+     *
+     * @return a {@link com.alipay.sofa.koupleless.arklet.core.api.ApiClient} object
+     */
     public static ApiClient getApiClientInstance() {
         return componentInjector.getInstance(ApiClient.class);
     }

arklet-core/src/main/java/com/alipay/sofa/koupleless/arklet/core/api/ApiClient.java

@@ -33,8 +33,11 @@
 import com.google.inject.multibindings.Multibinder;
 
 /**
+ * <p>ApiClient class.</p>
+ *
  * @author mingmen
- * @date 2023/6/8
+ * @since 2023/6/8
+ * @version 1.0.0
  */
 
 @Singleton
@@ -53,6 +56,7 @@ public class ApiClient implements ArkletComponent {
         }
     }
 
+    /** {@inheritDoc} */
     @Override
     public void init() {
         for (Tunnel tunnel : tunnelList) {
@@ -61,13 +65,19 @@ public void init() {
         }
     }
 
+    /** {@inheritDoc} */
     @Override
     public void destroy() {
         for (Tunnel tunnel : tunnelList) {
             tunnel.shutdown();
         }
     }
 
+    /**
+     * <p>getTunnels.</p>
+     *
+     * @return a {@link java.util.List} object
+     */
     public List<Tunnel> getTunnels() {
         return tunnelList;
     }

arklet-core/src/main/java/com/alipay/sofa/koupleless/arklet/core/api/model/Response.java

@@ -19,8 +19,11 @@
 import com.alipay.sofa.koupleless.arklet.core.command.meta.Output;
 
 /**
+ * <p>Response class.</p>
+ *
  * @author mingmen
- * @date 2023/6/26
+ * @since 2023/6/26
+ * @version 1.0.0
  */
 public class Response {
 
@@ -44,6 +47,12 @@ public class Response {
      */
     private String       errorStackTrace;
 
+    /**
+     * <p>fromCommandOutput.</p>
+     *
+     * @param output a {@link com.alipay.sofa.koupleless.arklet.core.command.meta.Output} object
+     * @return a {@link com.alipay.sofa.koupleless.arklet.core.api.model.Response} object
+     */
     public static Response fromCommandOutput(Output output) {
         Response response = new Response();
         response.code = output.getCode();
@@ -52,27 +61,51 @@ public static Response fromCommandOutput(Output output) {
         return response;
     }
 
+    /**
+     * <p>success.</p>
+     *
+     * @param data a {@link java.lang.Object} object
+     * @return a {@link com.alipay.sofa.koupleless.arklet.core.api.model.Response} object
+     */
     public static Response success(Object data) {
         Response response = new Response();
         response.code = ResponseCode.SUCCESS;
         response.data = data;
         return response;
     }
 
+    /**
+     * <p>failed.</p>
+     *
+     * @param message a {@link java.lang.String} object
+     * @return a {@link com.alipay.sofa.koupleless.arklet.core.api.model.Response} object
+     */
     public static Response failed(String message) {
         Response response = new Response();
         response.code = ResponseCode.FAILED;
         response.message = message;
         return response;
     }
 
+    /**
+     * <p>notFound.</p>
+     *
+     * @return a {@link com.alipay.sofa.koupleless.arklet.core.api.model.Response} object
+     */
     public static Response notFound() {
         Response response = new Response();
         response.code = ResponseCode.CMD_NOT_FOUND;
         response.message = "please follow the doc";
         return response;
     }
 
+    /**
+     * <p>internalError.</p>
+     *
+     * @param message a {@link java.lang.String} object
+     * @param errorStackTrace a {@link java.lang.String} object
+     * @return a {@link com.alipay.sofa.koupleless.arklet.core.api.model.Response} object
+     */
     public static Response internalError(String message, String errorStackTrace) {
         Response response = new Response();
         response.code = ResponseCode.CMD_PROCESS_INTERNAL_ERROR;
@@ -81,34 +114,74 @@ public static Response internalError(String message, String errorStackTrace) {
         return response;
     }
 
+    /**
+     * <p>Getter for the field <code>message</code>.</p>
+     *
+     * @return a {@link java.lang.String} object
+     */
     public String getMessage() {
         return message;
     }
 
+    /**
+     * <p>Setter for the field <code>message</code>.</p>
+     *
+     * @param message a {@link java.lang.String} object
+     */
     public void setMessage(String message) {
         this.message = message;
     }
 
+    /**
+     * <p>Getter for the field <code>data</code>.</p>
+     *
+     * @return a {@link java.lang.Object} object
+     */
     public Object getData() {
         return data;
     }
 
+    /**
+     * <p>Setter for the field <code>data</code>.</p>
+     *
+     * @param data a {@link java.lang.Object} object
+     */
     public void setData(Object data) {
         this.data = data;
     }
 
+    /**
+     * <p>Getter for the field <code>code</code>.</p>
+     *
+     * @return a {@link com.alipay.sofa.koupleless.arklet.core.api.model.ResponseCode} object
+     */
     public ResponseCode getCode() {
         return code;
     }
 
+    /**
+     * <p>Setter for the field <code>code</code>.</p>
+     *
+     * @param code a {@link com.alipay.sofa.koupleless.arklet.core.api.model.ResponseCode} object
+     */
     public void setCode(ResponseCode code) {
         this.code = code;
     }
 
+    /**
+     * <p>Getter for the field <code>errorStackTrace</code>.</p>
+     *
+     * @return a {@link java.lang.String} object
+     */
     public String getErrorStackTrace() {
         return errorStackTrace;
     }
 
+    /**
+     * <p>Setter for the field <code>errorStackTrace</code>.</p>
+     *
+     * @param errorStackTrace a {@link java.lang.String} object
+     */
     public void setErrorStackTrace(String errorStackTrace) {
         this.errorStackTrace = errorStackTrace;
     }

arklet-core/src/main/java/com/alipay/sofa/koupleless/arklet/core/api/model/ResponseCode.java

@@ -17,10 +17,12 @@
 package com.alipay.sofa.koupleless.arklet.core.api.model;
 
 /**
+ * <p>ResponseCode class.</p>
+ *
  * @author mingmen
- * @date 2023/6/26
+ * @since 2023/6/26
+ * @version 1.0.0
  */
-
 public enum ResponseCode {
                           SUCCESS(200), FAILED(400), CMD_NOT_FOUND(404), CMD_PROCESS_INTERNAL_ERROR(500);
 
@@ -30,6 +32,11 @@ public enum ResponseCode {
         this.code = code;
     }
 
+    /**
+     * <p>Getter for the field <code>code</code>.</p>
+     *
+     * @return a int
+     */
     public int getCode() {
         return code;
     }

arklet-core/src/main/java/com/alipay/sofa/koupleless/arklet/core/api/tunnel/Tunnel.java

@@ -19,14 +19,28 @@
 import com.alipay.sofa.koupleless.arklet.core.command.CommandService;
 
 /**
+ * <p>Tunnel interface.</p>
+ *
  * @author mingmen
- * @date 2023/6/8
+ * @since 2023/6/8
+ * @version 1.0.0
  */
 public interface Tunnel {
 
+    /**
+     * <p>init.</p>
+     *
+     * @param commandService a {@link com.alipay.sofa.koupleless.arklet.core.command.CommandService} object
+     */
     void init(CommandService commandService);
 
+    /**
+     * <p>run.</p>
+     */
     void run();
 
+    /**
+     * <p>shutdown.</p>
+     */
     void shutdown();
 }

arklet-core/src/main/java/com/alipay/sofa/koupleless/arklet/core/api/tunnel/http/HttpTunnel.java

@@ -31,8 +31,11 @@
 import com.google.inject.Singleton;
 
 /**
+ * <p>HttpTunnel class.</p>
+ *
  * @author mingmen
- * @date 2023/6/8
+ * @since 2023/6/8
+ * @version 1.0.0
  */
 
 @Singleton
@@ -50,6 +53,7 @@ public class HttpTunnel implements Tunnel {
     private final AtomicBoolean       run                      = new AtomicBoolean(false);
     private CommandService            commandService;
 
+    /** {@inheritDoc} */
     @Override
     public void init(CommandService commandService) {
         if (init.compareAndSet(false, true)) {
@@ -69,6 +73,7 @@ public void init(CommandService commandService) {
         }
     }
 
+    /** {@inheritDoc} */
     @Override
     public void run() {
         if (run.compareAndSet(false, true)) {
@@ -84,6 +89,7 @@ public void run() {
         }
     }
 
+    /** {@inheritDoc} */
     @Override
     public void shutdown() {
         if (shutdown.compareAndSet(false, true)) {