注释

ClayGminx · Sep 12, 2022 · 1fd8ebc · 1fd8ebc
1 parent e5df006
commit 1fd8ebc
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 3 deletions.
diff --git a/src/main/java/claygminx/common/Dict.java b/src/main/java/claygminx/common/Dict.java
@@ -41,7 +41,6 @@ public static class General {
         public final static String GITHUB_RESPONSE_TIMEOUT = "github.responseTimeout";
         public final static String GITHUB_DOWNLOAD_TITLE = "github.downloadTitle";
 
-
         // PPT
         public final static String WORSHIP_MODEL_PREFIX = "worship.model.";
         public final static String PPT_PROCEDURE_XML_PATH = "ppt.procedure.path";

diff --git a/src/main/java/claygminx/components/ScriptureService.java b/src/main/java/claygminx/components/ScriptureService.java
@@ -4,8 +4,6 @@
 import claygminx.common.entity.ScriptureNumberEntity;
 import claygminx.exception.ScriptureNumberException;
 
-import static claygminx.common.Dict.*;
-
 /**
  * 经文服务
  */

diff --git a/src/main/java/claygminx/components/WorshipProcedureService.java b/src/main/java/claygminx/components/WorshipProcedureService.java
@@ -11,6 +11,13 @@
  */
 public interface WorshipProcedureService {
 
+    /**
+     * 生成敬拜流程
+     * @param ppt PPT对象
+     * @param worshipEntity 敬拜参数实体
+     * @return 敬拜流程
+     * @throws FileServiceException 若读取定义敬拜流程的XML文件失败，则抛出此异常
+     */
     List<WorshipStep> generate(XMLSlideShow ppt, WorshipEntity worshipEntity) throws FileServiceException;
 
 }