From 596674381131fba305e2cd473753a18c3209f66e Mon Sep 17 00:00:00 2001
From: itning <itning@itning.top>
Date: Tue, 7 May 2019 08:42:42 +0800
Subject: [PATCH] work comment

---
 .../java/top/itning/server/shwwork/client/GroupClient.java     | 2 ++
 .../java/top/itning/server/shwwork/client/SecurityClient.java  | 2 ++
 .../top/itning/server/shwwork/client/StudentGroupClient.java   | 2 ++
 .../java/top/itning/server/shwwork/client/UploadClient.java    | 2 ++
 .../java/top/itning/server/shwwork/client/entity/Group.java    | 2 ++
 .../java/top/itning/server/shwwork/client/entity/Student.java  | 2 ++
 .../top/itning/server/shwwork/client/entity/StudentGroup.java  | 2 ++
 .../java/top/itning/server/shwwork/client/entity/Upload.java   | 2 ++
 .../top/itning/server/shwwork/config/ModelMapperConfig.java    | 2 ++
 .../src/main/java/top/itning/server/shwwork/dto/WorkDTO.java   | 2 ++
 .../java/top/itning/server/shwwork/dto/WorkDetailsDTO.java     | 2 +-
 .../src/main/java/top/itning/server/shwwork/entity/Work.java   | 2 ++
 .../itning/server/shwwork/exception/GlobalErrorAttributes.java | 3 +++
 .../shwwork/exception/GlobalErrorWebExceptionHandler.java      | 2 ++
 .../itning/server/shwwork/exception/JsonHttpMessageWriter.java | 3 +++
 .../java/top/itning/server/shwwork/handler/WorkHandler.java    | 2 ++
 .../top/itning/server/shwwork/repository/WorkRepository.java   | 2 ++
 .../java/top/itning/server/shwwork/router/WorkRouters.java     | 2 ++
 .../java/top/itning/server/shwwork/service/WorkService.java    | 2 ++
 .../itning/server/shwwork/service/impl/WorkServiceImpl.java    | 2 ++
 .../java/top/itning/server/shwwork/stream/DelGroupMessage.java | 2 ++
 .../java/top/itning/server/shwwork/stream/DelWorkMessage.java  | 2 ++
 .../src/main/java/top/itning/server/shwwork/util/Tuple.java    | 2 ++
 .../src/main/java/top/itning/server/shwwork/util/Tuple3.java   | 2 ++
 24 files changed, 49 insertions(+), 1 deletion(-)

diff --git a/shw-work/src/main/java/top/itning/server/shwwork/client/GroupClient.java b/shw-work/src/main/java/top/itning/server/shwwork/client/GroupClient.java
index 1ddad49..0300b86 100644
--- a/shw-work/src/main/java/top/itning/server/shwwork/client/GroupClient.java
+++ b/shw-work/src/main/java/top/itning/server/shwwork/client/GroupClient.java
@@ -10,6 +10,8 @@
 import java.util.Optional;
 
 /**
+ * 群组远程调用
+ *
  * @author itning
  * @date 2019/5/1 14:23
  */
diff --git a/shw-work/src/main/java/top/itning/server/shwwork/client/SecurityClient.java b/shw-work/src/main/java/top/itning/server/shwwork/client/SecurityClient.java
index 1429ce8..e9c4144 100644
--- a/shw-work/src/main/java/top/itning/server/shwwork/client/SecurityClient.java
+++ b/shw-work/src/main/java/top/itning/server/shwwork/client/SecurityClient.java
@@ -9,6 +9,8 @@
 import java.util.Optional;
 
 /**
+ * Security远程调用
+ *
  * @author itning
  * @date 2019/5/3 15:57
  */
diff --git a/shw-work/src/main/java/top/itning/server/shwwork/client/StudentGroupClient.java b/shw-work/src/main/java/top/itning/server/shwwork/client/StudentGroupClient.java
index 7ddd769..0819d30 100644
--- a/shw-work/src/main/java/top/itning/server/shwwork/client/StudentGroupClient.java
+++ b/shw-work/src/main/java/top/itning/server/shwwork/client/StudentGroupClient.java
@@ -9,6 +9,8 @@
 import java.util.List;
 
 /**
+ * 学生群组远程调用
+ *
  * @author itning
  * @date 2019/5/1 9:51
  */
diff --git a/shw-work/src/main/java/top/itning/server/shwwork/client/UploadClient.java b/shw-work/src/main/java/top/itning/server/shwwork/client/UploadClient.java
index 49c168d..8ecbf4f 100644
--- a/shw-work/src/main/java/top/itning/server/shwwork/client/UploadClient.java
+++ b/shw-work/src/main/java/top/itning/server/shwwork/client/UploadClient.java
@@ -9,6 +9,8 @@
 import java.util.Optional;
 
 /**
+ * 上传远程调用
+ *
  * @author itning
  * @date 2019/5/3 14:27
  */
diff --git a/shw-work/src/main/java/top/itning/server/shwwork/client/entity/Group.java b/shw-work/src/main/java/top/itning/server/shwwork/client/entity/Group.java
index dbfcf15..828fe7f 100644
--- a/shw-work/src/main/java/top/itning/server/shwwork/client/entity/Group.java
+++ b/shw-work/src/main/java/top/itning/server/shwwork/client/entity/Group.java
@@ -4,6 +4,8 @@
 import java.util.UUID;
 
 /**
+ * 群组
+ *
  * @author itning
  * @date 2019/4/29 11:43
  */
diff --git a/shw-work/src/main/java/top/itning/server/shwwork/client/entity/Student.java b/shw-work/src/main/java/top/itning/server/shwwork/client/entity/Student.java
index 643afac..a3250b3 100644
--- a/shw-work/src/main/java/top/itning/server/shwwork/client/entity/Student.java
+++ b/shw-work/src/main/java/top/itning/server/shwwork/client/entity/Student.java
@@ -1,6 +1,8 @@
 package top.itning.server.shwwork.client.entity;
 
 /**
+ * 学生
+ *
  * @author itning
  * @date 2019/4/30 13:08
  */
diff --git a/shw-work/src/main/java/top/itning/server/shwwork/client/entity/StudentGroup.java b/shw-work/src/main/java/top/itning/server/shwwork/client/entity/StudentGroup.java
index d8c95a4..fb9d5d1 100644
--- a/shw-work/src/main/java/top/itning/server/shwwork/client/entity/StudentGroup.java
+++ b/shw-work/src/main/java/top/itning/server/shwwork/client/entity/StudentGroup.java
@@ -3,6 +3,8 @@
 import java.util.Date;
 
 /**
+ * 学生群组
+ *
  * @author itning
  * @date 2019/4/30 17:47
  */
diff --git a/shw-work/src/main/java/top/itning/server/shwwork/client/entity/Upload.java b/shw-work/src/main/java/top/itning/server/shwwork/client/entity/Upload.java
index b412f82..eada6c3 100644
--- a/shw-work/src/main/java/top/itning/server/shwwork/client/entity/Upload.java
+++ b/shw-work/src/main/java/top/itning/server/shwwork/client/entity/Upload.java
@@ -3,6 +3,8 @@
 import java.util.Date;
 
 /**
+ * 上传
+ *
  * @author itning
  * @date 2019/5/2 16:48
  */
diff --git a/shw-work/src/main/java/top/itning/server/shwwork/config/ModelMapperConfig.java b/shw-work/src/main/java/top/itning/server/shwwork/config/ModelMapperConfig.java
index f4e1f12..a7ab8a1 100644
--- a/shw-work/src/main/java/top/itning/server/shwwork/config/ModelMapperConfig.java
+++ b/shw-work/src/main/java/top/itning/server/shwwork/config/ModelMapperConfig.java
@@ -10,6 +10,8 @@
 import top.itning.server.shwwork.entity.Work;
 
 /**
+ * ModelMapper Config
+ *
  * @author itning
  */
 @Component
diff --git a/shw-work/src/main/java/top/itning/server/shwwork/dto/WorkDTO.java b/shw-work/src/main/java/top/itning/server/shwwork/dto/WorkDTO.java
index c72bbea..78024c9 100644
--- a/shw-work/src/main/java/top/itning/server/shwwork/dto/WorkDTO.java
+++ b/shw-work/src/main/java/top/itning/server/shwwork/dto/WorkDTO.java
@@ -3,6 +3,8 @@
 import java.util.Date;
 
 /**
+ * 作业DTO
+ *
  * @author itning
  * @date 2019/5/1 9:47
  */
diff --git a/shw-work/src/main/java/top/itning/server/shwwork/dto/WorkDetailsDTO.java b/shw-work/src/main/java/top/itning/server/shwwork/dto/WorkDetailsDTO.java
index f5abfb4..e97a843 100644
--- a/shw-work/src/main/java/top/itning/server/shwwork/dto/WorkDetailsDTO.java
+++ b/shw-work/src/main/java/top/itning/server/shwwork/dto/WorkDetailsDTO.java
@@ -6,7 +6,7 @@
 import java.io.Serializable;
 
 /**
- * 作业详情
+ * 作业详情DTO
  *
  * @author itning
  */
diff --git a/shw-work/src/main/java/top/itning/server/shwwork/entity/Work.java b/shw-work/src/main/java/top/itning/server/shwwork/entity/Work.java
index a728950..18b7a2c 100644
--- a/shw-work/src/main/java/top/itning/server/shwwork/entity/Work.java
+++ b/shw-work/src/main/java/top/itning/server/shwwork/entity/Work.java
@@ -9,6 +9,8 @@
 import java.util.UUID;
 
 /**
+ * 作业
+ *
  * @author itning
  * @date 2019/5/1 9:36
  */
diff --git a/shw-work/src/main/java/top/itning/server/shwwork/exception/GlobalErrorAttributes.java b/shw-work/src/main/java/top/itning/server/shwwork/exception/GlobalErrorAttributes.java
index c96c1ca..660f39d 100644
--- a/shw-work/src/main/java/top/itning/server/shwwork/exception/GlobalErrorAttributes.java
+++ b/shw-work/src/main/java/top/itning/server/shwwork/exception/GlobalErrorAttributes.java
@@ -11,6 +11,9 @@
 import java.util.Map;
 
 /**
+ * 错误信息属性填充
+ * 该类扩展{@link DefaultErrorAttributes}将错误信息封装在MAP中
+ *
  * @author itning
  * @date 2019/4/29 18:11
  */
diff --git a/shw-work/src/main/java/top/itning/server/shwwork/exception/GlobalErrorWebExceptionHandler.java b/shw-work/src/main/java/top/itning/server/shwwork/exception/GlobalErrorWebExceptionHandler.java
index 278317d..fa23bea 100644
--- a/shw-work/src/main/java/top/itning/server/shwwork/exception/GlobalErrorWebExceptionHandler.java
+++ b/shw-work/src/main/java/top/itning/server/shwwork/exception/GlobalErrorWebExceptionHandler.java
@@ -15,6 +15,8 @@
 import java.util.Map;
 
 /**
+ * 全局错误异常处理器
+ *
  * @author itning
  * @date 2019/4/29 18:13
  */
diff --git a/shw-work/src/main/java/top/itning/server/shwwork/exception/JsonHttpMessageWriter.java b/shw-work/src/main/java/top/itning/server/shwwork/exception/JsonHttpMessageWriter.java
index a6e6508..868d284 100644
--- a/shw-work/src/main/java/top/itning/server/shwwork/exception/JsonHttpMessageWriter.java
+++ b/shw-work/src/main/java/top/itning/server/shwwork/exception/JsonHttpMessageWriter.java
@@ -14,6 +14,9 @@
 import java.util.Map;
 
 /**
+ * JSON格式消息写入器
+ * 该类解析MAP将其转换为JSON
+ *
  * @author itning
  * @date 2019/4/29 19:07
  */
diff --git a/shw-work/src/main/java/top/itning/server/shwwork/handler/WorkHandler.java b/shw-work/src/main/java/top/itning/server/shwwork/handler/WorkHandler.java
index d952c1d..51458b3 100644
--- a/shw-work/src/main/java/top/itning/server/shwwork/handler/WorkHandler.java
+++ b/shw-work/src/main/java/top/itning/server/shwwork/handler/WorkHandler.java
@@ -18,6 +18,8 @@
 import static top.itning.server.common.util.Preconditions.*;
 
 /**
+ * 作业处理器
+ *
  * @author itning
  * @date 2019/5/1 9:42
  */
diff --git a/shw-work/src/main/java/top/itning/server/shwwork/repository/WorkRepository.java b/shw-work/src/main/java/top/itning/server/shwwork/repository/WorkRepository.java
index 2c76c00..41edb37 100644
--- a/shw-work/src/main/java/top/itning/server/shwwork/repository/WorkRepository.java
+++ b/shw-work/src/main/java/top/itning/server/shwwork/repository/WorkRepository.java
@@ -4,6 +4,8 @@
 import top.itning.server.shwwork.entity.Work;
 
 /**
+ * 作业存储库
+ *
  * @author itning
  * @date 2019/5/1 9:50
  */
diff --git a/shw-work/src/main/java/top/itning/server/shwwork/router/WorkRouters.java b/shw-work/src/main/java/top/itning/server/shwwork/router/WorkRouters.java
index e49fb40..9930a20 100644
--- a/shw-work/src/main/java/top/itning/server/shwwork/router/WorkRouters.java
+++ b/shw-work/src/main/java/top/itning/server/shwwork/router/WorkRouters.java
@@ -15,6 +15,8 @@
 import static org.springframework.web.reactive.function.server.RouterFunctions.route;
 
 /**
+ * 作业路由
+ *
  * @author itning
  * @date 2019/5/1 9:42
  */
diff --git a/shw-work/src/main/java/top/itning/server/shwwork/service/WorkService.java b/shw-work/src/main/java/top/itning/server/shwwork/service/WorkService.java
index b1215ea..0cefb4e 100644
--- a/shw-work/src/main/java/top/itning/server/shwwork/service/WorkService.java
+++ b/shw-work/src/main/java/top/itning/server/shwwork/service/WorkService.java
@@ -8,6 +8,8 @@
 import top.itning.server.shwwork.entity.Work;
 
 /**
+ * 作业服务
+ *
  * @author itning
  * @date 2019/5/1 9:43
  */
diff --git a/shw-work/src/main/java/top/itning/server/shwwork/service/impl/WorkServiceImpl.java b/shw-work/src/main/java/top/itning/server/shwwork/service/impl/WorkServiceImpl.java
index 473d199..5afc03d 100644
--- a/shw-work/src/main/java/top/itning/server/shwwork/service/impl/WorkServiceImpl.java
+++ b/shw-work/src/main/java/top/itning/server/shwwork/service/impl/WorkServiceImpl.java
@@ -33,6 +33,8 @@
 import java.util.stream.Collectors;
 
 /**
+ * 作业服务实现
+ *
  * @author itning
  * @date 2019/5/1 9:49
  */
diff --git a/shw-work/src/main/java/top/itning/server/shwwork/stream/DelGroupMessage.java b/shw-work/src/main/java/top/itning/server/shwwork/stream/DelGroupMessage.java
index 0b91faf..0e2b2f5 100644
--- a/shw-work/src/main/java/top/itning/server/shwwork/stream/DelGroupMessage.java
+++ b/shw-work/src/main/java/top/itning/server/shwwork/stream/DelGroupMessage.java
@@ -5,6 +5,8 @@
 import org.springframework.messaging.SubscribableChannel;
 
 /**
+ * 删除群组消息
+ *
  * @author itning
  * @date 2019/5/4 14:19
  */
diff --git a/shw-work/src/main/java/top/itning/server/shwwork/stream/DelWorkMessage.java b/shw-work/src/main/java/top/itning/server/shwwork/stream/DelWorkMessage.java
index 2f6b26d..2195ccc 100644
--- a/shw-work/src/main/java/top/itning/server/shwwork/stream/DelWorkMessage.java
+++ b/shw-work/src/main/java/top/itning/server/shwwork/stream/DelWorkMessage.java
@@ -4,6 +4,8 @@
 import org.springframework.messaging.MessageChannel;
 
 /**
+ * 删除作业消息
+ *
  * @author itning
  * @date 2019/5/4 13:42
  */
diff --git a/shw-work/src/main/java/top/itning/server/shwwork/util/Tuple.java b/shw-work/src/main/java/top/itning/server/shwwork/util/Tuple.java
index 5c9ac11..ab52e9d 100644
--- a/shw-work/src/main/java/top/itning/server/shwwork/util/Tuple.java
+++ b/shw-work/src/main/java/top/itning/server/shwwork/util/Tuple.java
@@ -5,6 +5,8 @@
 import java.util.Objects;
 
 /**
+ * 包含两个对象的Tuple
+ *
  * @author itning
  * @date 2019/4/30 21:47
  */
diff --git a/shw-work/src/main/java/top/itning/server/shwwork/util/Tuple3.java b/shw-work/src/main/java/top/itning/server/shwwork/util/Tuple3.java
index 40b1e68..861d751 100644
--- a/shw-work/src/main/java/top/itning/server/shwwork/util/Tuple3.java
+++ b/shw-work/src/main/java/top/itning/server/shwwork/util/Tuple3.java
@@ -5,6 +5,8 @@
 import java.util.Objects;
 
 /**
+ * 包含三个对象的Tuple
+ *
  * @author itning
  * @date 2019/4/30 21:47
  */