fix build doc (#612)

qiniu · Oct 31, 2024 · 38ecfe8 · 38ecfe8
1 parent 34de949
commit 38ecfe8
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 2 deletions.
diff --git a/src/main/java/com/qiniu/media/apis/ApiPrefop.java b/src/main/java/com/qiniu/media/apis/ApiPrefop.java
@@ -380,7 +380,7 @@ public String getPipeline() {
 
             /**
              * 获取变量值
-             * 如果没有，则表示通过 `api+fops` 命令提交的任务，否则遵循规则 `<source>: <source_id>`，其中 `<source>` 当前可选 `workflow` 或 `trigger`
+             * 如果没有，则表示通过 `api+fops` 命令提交的任务，否则遵循规则 `{source}:{source_id}`，其中 `{source}` 当前可选 `workflow` 或 `trigger`
              *
              * @return taskFrom
              */

diff --git a/src/main/java/com/qiniu/processing/OperationStatus.java b/src/main/java/com/qiniu/processing/OperationStatus.java
@@ -33,7 +33,7 @@ public class OperationStatus {
     /***
      * taskFrom
      * 1. 如果没有 taskFrom, 则表示是通过 api+fops命令 提交的任务, 否则见 2
-     * 2. taskFrom 字段规则: <source>: <source_id>，其中 source 当前可选: workflow|trigger
+     * 2. taskFrom 字段规则: {source}:{source_id}，其中 source 当前可选: workflow|trigger
      **/
     public String taskFrom;
 

diff --git a/src/main/java/com/qiniu/storage/Retry.java b/src/main/java/com/qiniu/storage/Retry.java
@@ -95,6 +95,8 @@ public interface Interval {
 
         /**
          * 重试时间间隔，单位：毫秒
+         *
+         * @return 重试时间间隔
          **/
         int interval();
     }
@@ -103,6 +105,11 @@ public interface RetryCondition {
 
         /**
          * 是否需要重试
+         *
+         * @param request   请求
+         * @param response  响应
+         * @param exception 异常
+         * @return 是否需要重试
          **/
         boolean shouldRetry(Api.Request request, Api.Response response, QiniuException exception);
     }

diff --git a/src/main/java/com/qiniu/util/UrlUtils.java b/src/main/java/com/qiniu/util/UrlUtils.java
@@ -210,6 +210,10 @@ public static URL parseHost(String host) {
     /**
      * 如果 host 包含 scheme 则优先使用 host 中包含的 scheme
      * 如果 host 不包含 scheme 则按照 useHttps 增加 scheme
+     *
+     * @param host 域名
+     * @param useHttps 是否使用 https
+     * @return 合成后的 url
      */
     public static String setHostScheme(String host, boolean useHttps) {
         if (host == null || StringUtils.isNullOrEmpty(host)) {