From ae03e36e19a5eeb644777826665f8781c4cfbf25 Mon Sep 17 00:00:00 2001 From: linwumingshi Date: Sun, 17 Mar 2024 10:15:06 +0800 Subject: [PATCH] feat: :sparkles: add websocket-markdown support;update license validity period --- .../chain/CommonArtifactFilterChain.java | 2 +- .../doc/gradle/chain/ContainsFilterChain.java | 2 +- .../com/ly/doc/gradle/chain/FilterChain.java | 2 +- .../doc/gradle/chain/GroupIdFilterChain.java | 2 +- .../chain/SpringBootArtifactFilterChain.java | 2 +- .../gradle/chain/StartsWithFilterChain.java | 2 +- .../doc/gradle/constant/GlobalConstants.java | 8 +++- .../ly/doc/gradle/constant/TaskConstants.java | 18 ++++---- .../extension/SmartDocPluginExtension.java | 2 +- .../ly/doc/gradle/model/CustomArtifact.java | 2 +- .../ly/doc/gradle/plugin/SmartDocPlugin.java | 2 +- .../com/ly/doc/gradle/task/DocBaseTask.java | 2 +- .../com/ly/doc/gradle/task/JMeterTask.java | 2 +- .../com/ly/doc/gradle/task/OpenApiTask.java | 2 +- .../com/ly/doc/gradle/task/PostmanTask.java | 2 +- .../com/ly/doc/gradle/task/RestAdocTask.java | 2 +- .../com/ly/doc/gradle/task/RestHtmlTask.java | 2 +- .../ly/doc/gradle/task/RestMarkdownTask.java | 2 +- .../com/ly/doc/gradle/task/RpcAdocTask.java | 2 +- .../com/ly/doc/gradle/task/RpcHtmlTask.java | 2 +- .../ly/doc/gradle/task/RpcMarkdownTask.java | 2 +- .../com/ly/doc/gradle/task/SwaggerTask.java | 2 +- .../com/ly/doc/gradle/task/TornaRestTask.java | 2 +- .../com/ly/doc/gradle/task/TornaRpcTask.java | 2 +- .../gradle/task/WebSocketMarkdownTask.java | 44 +++++++++++++++++++ .../java/com/ly/doc/gradle/task/WordTask.java | 2 +- .../doc/gradle/util/ArtifactFilterUtil.java | 2 +- .../ly/doc/gradle/util/ClassLoaderUtil.java | 2 +- .../com/ly/doc/gradle/util/GradleUtil.java | 8 ++-- .../com/ly/doc/gradle/util/I18nMsgUtil.java | 5 ++- .../com/ly/doc/gradle/util/SourceSetUtil.java | 13 ++++-- 31 files changed, 103 insertions(+), 43 deletions(-) create mode 100644 src/main/java/com/ly/doc/gradle/task/WebSocketMarkdownTask.java diff --git a/src/main/java/com/ly/doc/gradle/chain/CommonArtifactFilterChain.java b/src/main/java/com/ly/doc/gradle/chain/CommonArtifactFilterChain.java index c7019ed..29a4a47 100644 --- a/src/main/java/com/ly/doc/gradle/chain/CommonArtifactFilterChain.java +++ b/src/main/java/com/ly/doc/gradle/chain/CommonArtifactFilterChain.java @@ -1,7 +1,7 @@ /* * smart-doc * - * Copyright (C) 2018-2023 smart-doc + * Copyright (C) 2018-2024 smart-doc * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file diff --git a/src/main/java/com/ly/doc/gradle/chain/ContainsFilterChain.java b/src/main/java/com/ly/doc/gradle/chain/ContainsFilterChain.java index 4e656a2..2c90fbe 100644 --- a/src/main/java/com/ly/doc/gradle/chain/ContainsFilterChain.java +++ b/src/main/java/com/ly/doc/gradle/chain/ContainsFilterChain.java @@ -1,7 +1,7 @@ /* * smart-doc * - * Copyright (C) 2018-2023 smart-doc + * Copyright (C) 2018-2024 smart-doc * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file diff --git a/src/main/java/com/ly/doc/gradle/chain/FilterChain.java b/src/main/java/com/ly/doc/gradle/chain/FilterChain.java index ca8d95a..40c471a 100644 --- a/src/main/java/com/ly/doc/gradle/chain/FilterChain.java +++ b/src/main/java/com/ly/doc/gradle/chain/FilterChain.java @@ -1,7 +1,7 @@ /* * smart-doc * - * Copyright (C) 2018-2023 smart-doc + * Copyright (C) 2018-2024 smart-doc * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file diff --git a/src/main/java/com/ly/doc/gradle/chain/GroupIdFilterChain.java b/src/main/java/com/ly/doc/gradle/chain/GroupIdFilterChain.java index 998b46b..5c8dcc3 100644 --- a/src/main/java/com/ly/doc/gradle/chain/GroupIdFilterChain.java +++ b/src/main/java/com/ly/doc/gradle/chain/GroupIdFilterChain.java @@ -1,7 +1,7 @@ /* * smart-doc * - * Copyright (C) 2018-2023 smart-doc + * Copyright (C) 2018-2024 smart-doc * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file diff --git a/src/main/java/com/ly/doc/gradle/chain/SpringBootArtifactFilterChain.java b/src/main/java/com/ly/doc/gradle/chain/SpringBootArtifactFilterChain.java index 1e8700d..de37147 100644 --- a/src/main/java/com/ly/doc/gradle/chain/SpringBootArtifactFilterChain.java +++ b/src/main/java/com/ly/doc/gradle/chain/SpringBootArtifactFilterChain.java @@ -1,7 +1,7 @@ /* * smart-doc * - * Copyright (C) 2018-2023 smart-doc + * Copyright (C) 2018-2024 smart-doc * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file diff --git a/src/main/java/com/ly/doc/gradle/chain/StartsWithFilterChain.java b/src/main/java/com/ly/doc/gradle/chain/StartsWithFilterChain.java index c16caa6..465c2d1 100644 --- a/src/main/java/com/ly/doc/gradle/chain/StartsWithFilterChain.java +++ b/src/main/java/com/ly/doc/gradle/chain/StartsWithFilterChain.java @@ -1,7 +1,7 @@ /* * smart-doc * - * Copyright (C) 2018-2023 smart-doc + * Copyright (C) 2018-2024 smart-doc * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file diff --git a/src/main/java/com/ly/doc/gradle/constant/GlobalConstants.java b/src/main/java/com/ly/doc/gradle/constant/GlobalConstants.java index 824ee89..ba2765b 100644 --- a/src/main/java/com/ly/doc/gradle/constant/GlobalConstants.java +++ b/src/main/java/com/ly/doc/gradle/constant/GlobalConstants.java @@ -1,7 +1,7 @@ /* * smart-doc * - * Copyright (C) 2018-2023 smart-doc + * Copyright (C) 2018-2024 smart-doc * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file @@ -104,8 +104,12 @@ public interface GlobalConstants { /** * Generate Swagger document */ - String Swagger_TASK = "swagger"; + String SWAGGER_TASK = "swagger"; + /** + * Generate WebSocket markdown document + */ + String WEBSOCKET_MARKDOWN = "webSocketMarkdown"; /** * Plugin extension name diff --git a/src/main/java/com/ly/doc/gradle/constant/TaskConstants.java b/src/main/java/com/ly/doc/gradle/constant/TaskConstants.java index fa5d03a..477170b 100644 --- a/src/main/java/com/ly/doc/gradle/constant/TaskConstants.java +++ b/src/main/java/com/ly/doc/gradle/constant/TaskConstants.java @@ -1,7 +1,7 @@ /* * smart-doc * - * Copyright (C) 2018-2023 smart-doc + * Copyright (C) 2018-2024 smart-doc * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file @@ -35,10 +35,10 @@ public class TaskConstants { /** * Map of Gradle Task */ - public static Map taskMap = new HashMap<>(); + public static Map> taskMap = new HashMap<>(); static { - //create html + // create html taskMap.put(GlobalConstants.REST_HTML_TASK, RestHtmlTask.class); // create adoc taskMap.put(GlobalConstants.REST_ADOC_TASK, RestAdocTask.class); @@ -50,19 +50,21 @@ public class TaskConstants { taskMap.put(GlobalConstants.POSTMAN_TASK, PostmanTask.class); // create open api taskMap.put(GlobalConstants.OPEN_API_TASK, OpenApiTask.class); - //create rpc html + // create rpc html taskMap.put(GlobalConstants.RPC_HTML_TASK, RpcHtmlTask.class); // create rpc adoc taskMap.put(GlobalConstants.RPC_ADOC_TASK, RpcAdocTask.class); - // create rpc markdown + // create rpc Markdown taskMap.put(GlobalConstants.RPC_MARKDOWN_TASK, RpcMarkdownTask.class); // create torna rest - taskMap.put(GlobalConstants.TORNA_REST_TASK,TornaRestTask.class); + taskMap.put(GlobalConstants.TORNA_REST_TASK, TornaRestTask.class); // create torna rpc - taskMap.put(GlobalConstants.TORNA_RPC_TASK,TornaRpcTask.class); + taskMap.put(GlobalConstants.TORNA_RPC_TASK, TornaRpcTask.class); // create word rest taskMap.put(GlobalConstants.WORD_TASK, WordTask.class); // create Swagger - taskMap.put(GlobalConstants.Swagger_TASK, SwaggerTask.class); + taskMap.put(GlobalConstants.SWAGGER_TASK, SwaggerTask.class); + // create websocket markdown + taskMap.put(GlobalConstants.WEBSOCKET_MARKDOWN, WebSocketMarkdownTask.class); } } diff --git a/src/main/java/com/ly/doc/gradle/extension/SmartDocPluginExtension.java b/src/main/java/com/ly/doc/gradle/extension/SmartDocPluginExtension.java index e6c581c..55be9e7 100644 --- a/src/main/java/com/ly/doc/gradle/extension/SmartDocPluginExtension.java +++ b/src/main/java/com/ly/doc/gradle/extension/SmartDocPluginExtension.java @@ -1,7 +1,7 @@ /* * smart-doc * - * Copyright (C) 2018-2023 smart-doc + * Copyright (C) 2018-2024 smart-doc * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file diff --git a/src/main/java/com/ly/doc/gradle/model/CustomArtifact.java b/src/main/java/com/ly/doc/gradle/model/CustomArtifact.java index d1aa720..996af4e 100644 --- a/src/main/java/com/ly/doc/gradle/model/CustomArtifact.java +++ b/src/main/java/com/ly/doc/gradle/model/CustomArtifact.java @@ -1,7 +1,7 @@ /* * smart-doc * - * Copyright (C) 2018-2023 smart-doc + * Copyright (C) 2018-2024 smart-doc * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file diff --git a/src/main/java/com/ly/doc/gradle/plugin/SmartDocPlugin.java b/src/main/java/com/ly/doc/gradle/plugin/SmartDocPlugin.java index 6b3b82e..29c4ecf 100644 --- a/src/main/java/com/ly/doc/gradle/plugin/SmartDocPlugin.java +++ b/src/main/java/com/ly/doc/gradle/plugin/SmartDocPlugin.java @@ -1,7 +1,7 @@ /* * smart-doc * - * Copyright (C) 2018-2023 smart-doc + * Copyright (C) 2018-2024 smart-doc * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file diff --git a/src/main/java/com/ly/doc/gradle/task/DocBaseTask.java b/src/main/java/com/ly/doc/gradle/task/DocBaseTask.java index 9f69c05..2879890 100644 --- a/src/main/java/com/ly/doc/gradle/task/DocBaseTask.java +++ b/src/main/java/com/ly/doc/gradle/task/DocBaseTask.java @@ -1,7 +1,7 @@ /* * smart-doc * - * Copyright (C) 2018-2023 smart-doc + * Copyright (C) 2018-2024 smart-doc * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file diff --git a/src/main/java/com/ly/doc/gradle/task/JMeterTask.java b/src/main/java/com/ly/doc/gradle/task/JMeterTask.java index 8b61e7c..61480e7 100644 --- a/src/main/java/com/ly/doc/gradle/task/JMeterTask.java +++ b/src/main/java/com/ly/doc/gradle/task/JMeterTask.java @@ -1,7 +1,7 @@ /* * smart-doc * - * Copyright (C) 2018-2023 smart-doc + * Copyright (C) 2018-2024 smart-doc * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file diff --git a/src/main/java/com/ly/doc/gradle/task/OpenApiTask.java b/src/main/java/com/ly/doc/gradle/task/OpenApiTask.java index 34cdce7..52ce423 100644 --- a/src/main/java/com/ly/doc/gradle/task/OpenApiTask.java +++ b/src/main/java/com/ly/doc/gradle/task/OpenApiTask.java @@ -1,7 +1,7 @@ /* * smart-doc * - * Copyright (C) 2018-2023 smart-doc + * Copyright (C) 2018-2024 smart-doc * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file diff --git a/src/main/java/com/ly/doc/gradle/task/PostmanTask.java b/src/main/java/com/ly/doc/gradle/task/PostmanTask.java index a6a980f..0a30d34 100644 --- a/src/main/java/com/ly/doc/gradle/task/PostmanTask.java +++ b/src/main/java/com/ly/doc/gradle/task/PostmanTask.java @@ -1,7 +1,7 @@ /* * smart-doc * - * Copyright (C) 2018-2023 smart-doc + * Copyright (C) 2018-2024 smart-doc * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file diff --git a/src/main/java/com/ly/doc/gradle/task/RestAdocTask.java b/src/main/java/com/ly/doc/gradle/task/RestAdocTask.java index 3e73bfd..f058b34 100644 --- a/src/main/java/com/ly/doc/gradle/task/RestAdocTask.java +++ b/src/main/java/com/ly/doc/gradle/task/RestAdocTask.java @@ -1,7 +1,7 @@ /* * smart-doc * - * Copyright (C) 2018-2023 smart-doc + * Copyright (C) 2018-2024 smart-doc * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file diff --git a/src/main/java/com/ly/doc/gradle/task/RestHtmlTask.java b/src/main/java/com/ly/doc/gradle/task/RestHtmlTask.java index e4e9085..5c2a940 100644 --- a/src/main/java/com/ly/doc/gradle/task/RestHtmlTask.java +++ b/src/main/java/com/ly/doc/gradle/task/RestHtmlTask.java @@ -1,7 +1,7 @@ /* * smart-doc * - * Copyright (C) 2018-2023 smart-doc + * Copyright (C) 2018-2024 smart-doc * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file diff --git a/src/main/java/com/ly/doc/gradle/task/RestMarkdownTask.java b/src/main/java/com/ly/doc/gradle/task/RestMarkdownTask.java index be3c068..58aa0f2 100644 --- a/src/main/java/com/ly/doc/gradle/task/RestMarkdownTask.java +++ b/src/main/java/com/ly/doc/gradle/task/RestMarkdownTask.java @@ -1,7 +1,7 @@ /* * smart-doc * - * Copyright (C) 2018-2023 smart-doc + * Copyright (C) 2018-2024 smart-doc * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file diff --git a/src/main/java/com/ly/doc/gradle/task/RpcAdocTask.java b/src/main/java/com/ly/doc/gradle/task/RpcAdocTask.java index 478430b..b54ddfc 100644 --- a/src/main/java/com/ly/doc/gradle/task/RpcAdocTask.java +++ b/src/main/java/com/ly/doc/gradle/task/RpcAdocTask.java @@ -1,7 +1,7 @@ /* * smart-doc * - * Copyright (C) 2018-2023 smart-doc + * Copyright (C) 2018-2024 smart-doc * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file diff --git a/src/main/java/com/ly/doc/gradle/task/RpcHtmlTask.java b/src/main/java/com/ly/doc/gradle/task/RpcHtmlTask.java index 405c145..66aad06 100644 --- a/src/main/java/com/ly/doc/gradle/task/RpcHtmlTask.java +++ b/src/main/java/com/ly/doc/gradle/task/RpcHtmlTask.java @@ -1,7 +1,7 @@ /* * smart-doc * - * Copyright (C) 2018-2023 smart-doc + * Copyright (C) 2018-2024 smart-doc * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file diff --git a/src/main/java/com/ly/doc/gradle/task/RpcMarkdownTask.java b/src/main/java/com/ly/doc/gradle/task/RpcMarkdownTask.java index 1a740df..5cf88ff 100644 --- a/src/main/java/com/ly/doc/gradle/task/RpcMarkdownTask.java +++ b/src/main/java/com/ly/doc/gradle/task/RpcMarkdownTask.java @@ -1,7 +1,7 @@ /* * smart-doc * - * Copyright (C) 2018-2023 smart-doc + * Copyright (C) 2018-2024 smart-doc * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file diff --git a/src/main/java/com/ly/doc/gradle/task/SwaggerTask.java b/src/main/java/com/ly/doc/gradle/task/SwaggerTask.java index a4ca8b7..d0053c3 100644 --- a/src/main/java/com/ly/doc/gradle/task/SwaggerTask.java +++ b/src/main/java/com/ly/doc/gradle/task/SwaggerTask.java @@ -1,7 +1,7 @@ /* * smart-doc * - * Copyright (C) 2018-2023 smart-doc + * Copyright (C) 2018-2024 smart-doc * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file diff --git a/src/main/java/com/ly/doc/gradle/task/TornaRestTask.java b/src/main/java/com/ly/doc/gradle/task/TornaRestTask.java index ee2a50c..2e908c0 100644 --- a/src/main/java/com/ly/doc/gradle/task/TornaRestTask.java +++ b/src/main/java/com/ly/doc/gradle/task/TornaRestTask.java @@ -1,7 +1,7 @@ /* * smart-doc * - * Copyright (C) 2018-2023 smart-doc + * Copyright (C) 2018-2024 smart-doc * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file diff --git a/src/main/java/com/ly/doc/gradle/task/TornaRpcTask.java b/src/main/java/com/ly/doc/gradle/task/TornaRpcTask.java index cabad7e..ae60176 100644 --- a/src/main/java/com/ly/doc/gradle/task/TornaRpcTask.java +++ b/src/main/java/com/ly/doc/gradle/task/TornaRpcTask.java @@ -1,7 +1,7 @@ /* * smart-doc * - * Copyright (C) 2018-2023 smart-doc + * Copyright (C) 2018-2024 smart-doc * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file diff --git a/src/main/java/com/ly/doc/gradle/task/WebSocketMarkdownTask.java b/src/main/java/com/ly/doc/gradle/task/WebSocketMarkdownTask.java new file mode 100644 index 0000000..379bb1c --- /dev/null +++ b/src/main/java/com/ly/doc/gradle/task/WebSocketMarkdownTask.java @@ -0,0 +1,44 @@ +/* + * smart-doc + * + * Copyright (C) 2018-2024 smart-doc + * + * 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. + */ +package com.ly.doc.gradle.task; + +import com.ly.doc.builder.websocket.WebSocketMarkdownBuilder; +import com.ly.doc.model.ApiConfig; +import com.thoughtworks.qdox.JavaProjectBuilder; +import org.gradle.api.logging.Logger; + +/** + * Support for WebSocket markdown + * + * @author linwumingshi + */ +public class WebSocketMarkdownTask extends DocBaseTask { + @Override + public void executeAction(ApiConfig apiConfig, JavaProjectBuilder javaProjectBuilder, Logger logger) { + try { + WebSocketMarkdownBuilder.buildApiDoc(apiConfig, javaProjectBuilder); + } catch (Exception e) { + e.printStackTrace(); + } + } +} diff --git a/src/main/java/com/ly/doc/gradle/task/WordTask.java b/src/main/java/com/ly/doc/gradle/task/WordTask.java index 794a311..affb174 100644 --- a/src/main/java/com/ly/doc/gradle/task/WordTask.java +++ b/src/main/java/com/ly/doc/gradle/task/WordTask.java @@ -1,7 +1,7 @@ /* * smart-doc * - * Copyright (C) 2018-2023 smart-doc + * Copyright (C) 2018-2024 smart-doc * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file diff --git a/src/main/java/com/ly/doc/gradle/util/ArtifactFilterUtil.java b/src/main/java/com/ly/doc/gradle/util/ArtifactFilterUtil.java index 24b27c6..9f3ef4d 100644 --- a/src/main/java/com/ly/doc/gradle/util/ArtifactFilterUtil.java +++ b/src/main/java/com/ly/doc/gradle/util/ArtifactFilterUtil.java @@ -1,7 +1,7 @@ /* * smart-doc * - * Copyright (C) 2018-2023 smart-doc + * Copyright (C) 2018-2024 smart-doc * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file diff --git a/src/main/java/com/ly/doc/gradle/util/ClassLoaderUtil.java b/src/main/java/com/ly/doc/gradle/util/ClassLoaderUtil.java index d3a6288..c9c049e 100644 --- a/src/main/java/com/ly/doc/gradle/util/ClassLoaderUtil.java +++ b/src/main/java/com/ly/doc/gradle/util/ClassLoaderUtil.java @@ -1,7 +1,7 @@ /* * smart-doc * - * Copyright (C) 2018-2023 smart-doc + * Copyright (C) 2018-2024 smart-doc * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file diff --git a/src/main/java/com/ly/doc/gradle/util/GradleUtil.java b/src/main/java/com/ly/doc/gradle/util/GradleUtil.java index 8fb8be1..9dc3d3d 100644 --- a/src/main/java/com/ly/doc/gradle/util/GradleUtil.java +++ b/src/main/java/com/ly/doc/gradle/util/GradleUtil.java @@ -1,7 +1,7 @@ /* * smart-doc * - * Copyright (C) 2018-2023 smart-doc + * Copyright (C) 2018-2024 smart-doc * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file @@ -26,16 +26,17 @@ import com.google.gson.FieldAttributes; import com.google.gson.Gson; import com.google.gson.GsonBuilder; +import com.ly.doc.model.*; import com.power.common.util.FileUtil; import com.power.common.util.StringUtil; -import com.ly.doc.model.*; import org.gradle.api.Project; import org.gradle.api.logging.Logger; import java.io.File; import java.io.FileInputStream; import java.io.FileNotFoundException; -import java.util.*; +import java.util.List; +import java.util.Objects; /** * @author yu 2020/2/16. @@ -61,6 +62,7 @@ public boolean shouldSkipClass(Class aClass) { * * @param configFile config file * @param project Project object + * @param increment increment * @param log gradle plugin log * @return com.power.doc.model.ApiConfig */ diff --git a/src/main/java/com/ly/doc/gradle/util/I18nMsgUtil.java b/src/main/java/com/ly/doc/gradle/util/I18nMsgUtil.java index 0301ae3..f8fdb01 100644 --- a/src/main/java/com/ly/doc/gradle/util/I18nMsgUtil.java +++ b/src/main/java/com/ly/doc/gradle/util/I18nMsgUtil.java @@ -1,7 +1,7 @@ /* * smart-doc * - * Copyright (C) 2018-2023 smart-doc + * Copyright (C) 2018-2024 smart-doc * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file @@ -35,6 +35,9 @@ public interface I18nMsgUtil { /** * Abbreviations, instead of full writing: 👇 + * + * @param key key + * @return value */ @SuppressWarnings("JavadocDeclaration") static String get(String key) { diff --git a/src/main/java/com/ly/doc/gradle/util/SourceSetUtil.java b/src/main/java/com/ly/doc/gradle/util/SourceSetUtil.java index 54b3906..466e196 100644 --- a/src/main/java/com/ly/doc/gradle/util/SourceSetUtil.java +++ b/src/main/java/com/ly/doc/gradle/util/SourceSetUtil.java @@ -1,7 +1,7 @@ /* * smart-doc * - * Copyright (C) 2018-2023 smart-doc + * Copyright (C) 2018-2024 smart-doc * * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file @@ -22,8 +22,8 @@ */ package com.ly.doc.gradle.util; -import com.power.common.util.CollectionUtil; import com.ly.doc.constants.DocGlobalConstants; +import com.power.common.util.CollectionUtil; import org.gradle.api.Project; import org.gradle.api.file.SourceDirectorySet; import org.gradle.api.internal.tasks.DefaultSourceSetContainer; @@ -47,6 +47,8 @@ public interface SourceSetUtil { /** * inquire {@code SourceSet} configure the custom source code root directory * + * @param project project + * @return source code root directory * @implNote limited support: * not supported {@code SourceSet} inclusions and exclusions are configured in {@link SourceDirectorySet#getExcludes()} {@link SourceDirectorySet#getIncludes()} *

@@ -77,6 +79,9 @@ static Set getMainJava(Project project) { /** * try using the default project structure: src/main/java + * + * @param project Project + * @return optional default project structure */ static Optional getDefaultMainJava(Project project) { String projectDir = project.getProjectDir().getPath(); @@ -84,8 +89,8 @@ static Optional getDefaultMainJava(Project project) { File src = new File(projectCodePath); return src.exists() && src.listFiles() != null - ? Optional.of(src) - : Optional.empty(); + ? Optional.of(src) + : Optional.empty(); } }