Browse Source

docs: 增加文件作者注释

ChenSiTong 6 years ago
parent
commit
114d94f51d

+ 3 - 0
src/main/java/nju/seec/helper/ServletInitializer.java

@@ -3,6 +3,9 @@ package nju.seec.helper;
 import org.springframework.boot.builder.SpringApplicationBuilder;
 import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;
 
+/**
+ * @author cst
+ */
 public class ServletInitializer extends SpringBootServletInitializer {
     @Override
     protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {

+ 3 - 0
src/main/java/nju/seec/helper/data/converter/MapToJsonConverter.java

@@ -5,6 +5,9 @@ import nju.seec.helper.util.JsonUtils;
 import javax.persistence.AttributeConverter;
 import java.util.Map;
 
+/**
+ * @author cst
+ */
 @SuppressWarnings("rawtypes")
 public class MapToJsonConverter implements AttributeConverter<Map, String> {
     @Override

+ 3 - 0
src/main/java/nju/seec/helper/data/converter/SetToJsonConverter.java

@@ -5,6 +5,9 @@ import nju.seec.helper.util.JsonUtils;
 import javax.persistence.AttributeConverter;
 import java.util.Set;
 
+/**
+ * @author cst
+ */
 @SuppressWarnings("rawtypes")
 public class SetToJsonConverter implements AttributeConverter<Set, String> {
     @Override

+ 4 - 1
src/main/java/nju/seec/helper/logic/vo/AnswerVO.java

@@ -3,10 +3,13 @@ package nju.seec.helper.logic.vo;
 import lombok.Builder;
 import lombok.Data;
 
+/**
+ * @author cst
+ */
 @Data
 @Builder
 public class AnswerVO {
-    private int quizId;
+    private Integer quizId;
     private String answer;
     private String analysis;
 }

+ 6 - 0
src/main/java/nju/seec/helper/logic/vo/SlideQuizVO.java

@@ -1,4 +1,10 @@
 package nju.seec.helper.logic.vo;
 
+import lombok.Data;
+
+/**
+ * @author cst
+ */
+@Data
 public class SlideQuizVO {
 }

+ 6 - 2
src/main/java/nju/seec/helper/web/controller/SlideController.java

@@ -31,7 +31,7 @@ public class SlideController {
         this.slideService = slideService;
     }
 
-    @ApiOperation(value = "教师基于课程ID和关键字获取创建的幻灯片列表", notes = "支持定制化分页排序,例:" + "/course/seec?page=3&size=10&sort=id,asc&sort=name,desc" + ",即以id正向排序再以name倒序排序,请求第3页,返回10条数据")
+    @ApiOperation(value = "根据课程ID和关键字获取创建的幻灯片列表", notes = "支持定制化分页排序,例:" + "/course/seec?page=3&size=10&sort=id,asc&sort=name,desc" + ",即以id正向排序再以name倒序排序,请求第3页,返回10条数据")
     @GetMapping("/course/{courseId}")
     public PageResourceResponse<SlideVO> getSlides(@PathVariable String courseId,
                                                    @RequestParam(defaultValue = "") String key,
@@ -41,7 +41,7 @@ public class SlideController {
     }
 
 
-    @ApiOperation(value = "教师基于关键字获取创建的幻灯片列表", notes = "支持定制化分页排序,例:" + "/course/seec?page=3&size=10&sort=id,asc&sort=name,desc" + ",即以id正向排序再以name倒序排序,请求第3页,返回10条数据")
+    @ApiOperation(value = "根据关键字获取创建的幻灯片列表", notes = "支持定制化分页排序,例:" + "/course/seec?page=3&size=10&sort=id,asc&sort=name,desc" + ",即以id正向排序再以name倒序排序,请求第3页,返回10条数据")
     @GetMapping("")
     public PageResourceResponse<SlideVO> getSlides(@RequestParam(defaultValue = "") String key,
                                                    @ApiParam(hidden = true) @PageableDefault(size = Integer.MAX_VALUE, sort = "updateTime", direction = Sort.Direction.DESC) Pageable pageable) {
@@ -49,22 +49,26 @@ public class SlideController {
         return PageResourceResponse.of(slideVOs, PageResourceResponse.PageInfo.of(pageable.getPageNumber(), slideVOs.size()));
     }
 
+    @ApiOperation(value = "根据ID获取幻灯片")
     @GetMapping("/{slideId:\\d+}")
     public ResourceResponse<SlideVO> getSlide(@PathVariable int slideId) {
         return ResourceResponse.of(slideService.getOneSlide(slideId));
     }
 
 
+    @ApiOperation(value = "创建幻灯片")
     @PostMapping("/create")
     public ResourceResponse<SlideVO> create(@RequestBody @Validated SlideDTO slideDTO) {
         return ResourceResponse.of(slideService.create(slideDTO));
     }
 
+    @ApiOperation(value = "修改幻灯片")
     @PostMapping("/update")
     public ResourceResponse<SlideVO> update(@RequestBody @Validated SlideDTO slideDTO) {
         return ResourceResponse.of(slideService.update(slideDTO));
     }
 
+    @ApiOperation(value = "删除幻灯片")
     @PostMapping("/delete/{slideId:\\d+}")
     public EmptyResponse delete(@PathVariable int slideId) {
         slideService.delete(slideId);