diff --git a/servers/boe-server-all/pom.xml b/servers/boe-server-all/pom.xml index 9f4e7327..a798e473 100644 --- a/servers/boe-server-all/pom.xml +++ b/servers/boe-server-all/pom.xml @@ -240,6 +240,18 @@ 2.3.0 + + + com.github.shalousun + smart-doc + 2.7.7 + + + + javax.enterprise + cdi-api + 2.0 + @@ -265,6 +277,28 @@ true + + com.github.shalousun + smart-doc-maven-plugin + 2.7.7 + + + ./src/main/resources/smart-doc.json + + + ${project.description} + + + + + compile + + + html + + + + diff --git a/servers/boe-server-all/src/main/java/com/xboe/module/boecase/service/ICasesRecommendPushRecordService.java b/servers/boe-server-all/src/main/java/com/xboe/module/boecase/service/ICasesRecommendPushRecordService.java index e507e9c9..f073068c 100644 --- a/servers/boe-server-all/src/main/java/com/xboe/module/boecase/service/ICasesRecommendPushRecordService.java +++ b/servers/boe-server-all/src/main/java/com/xboe/module/boecase/service/ICasesRecommendPushRecordService.java @@ -14,7 +14,7 @@ public interface ICasesRecommendPushRecordService { /** * 案例推送 * - * @param + * @param boeParam * @return */ boolean launchPush(CasesRecommendLaunchVo casesRecommendLaunch, CurrentUser currentUser, String token); diff --git a/servers/boe-server-all/src/main/java/com/xboe/module/interaction/service/ICommentsService.java b/servers/boe-server-all/src/main/java/com/xboe/module/interaction/service/ICommentsService.java index 81718cad..d340a766 100644 --- a/servers/boe-server-all/src/main/java/com/xboe/module/interaction/service/ICommentsService.java +++ b/servers/boe-server-all/src/main/java/com/xboe/module/interaction/service/ICommentsService.java @@ -104,7 +104,7 @@ public interface ICommentsService { /** * 查询案例@的评论 - * @param + * @param boeParam * */ PageList findCasesTome(int pageIndex,int pageSize,Integer objType,String toaid,String uname,Boolean isread); diff --git a/servers/boe-server-all/src/main/java/com/xboe/school/study/api/StudyCourseApi.java b/servers/boe-server-all/src/main/java/com/xboe/school/study/api/StudyCourseApi.java index 8663e426..b856ba58 100644 --- a/servers/boe-server-all/src/main/java/com/xboe/school/study/api/StudyCourseApi.java +++ b/servers/boe-server-all/src/main/java/com/xboe/school/study/api/StudyCourseApi.java @@ -288,7 +288,7 @@ public class StudyCourseApi extends ApiBaseController{ /** * 记录学习信息,在学习每个资源时都要记录.前端用户打开课程资源按规则调用带着课程及学习信息调用此接口。 - * @param + * @param boeParam * @return 返回学习条目的id */ @PostMapping("/study") @@ -450,8 +450,8 @@ public class StudyCourseApi extends ApiBaseController{ * 音视频学习保存,初始化保存学习记录. * 如果已经保存,就不要再保存第二次了,前端注意控制 * {studyId,contentId,courseId,progress,contentType,studyDuration} - * @param - * @param + * @param boeParam + * @param boeParam * @return */ @PostMapping("/study-video-save") @@ -506,8 +506,8 @@ public class StudyCourseApi extends ApiBaseController{ } /** * 视频学习完 - * @param - * @param + * @param boeParam + * @param boeParam * @return */ @PostMapping("/study-video-finish") @@ -539,7 +539,7 @@ public class StudyCourseApi extends ApiBaseController{ /** * 记录视频的学习时间点,前端可以每10秒记录一次,时长是秒 * @param itemId 学习内容条目id - * @param + * @param boeParam * @return */ @PostMapping("/study-video-time") diff --git a/servers/boe-server-all/src/main/resources/smart-doc.json b/servers/boe-server-all/src/main/resources/smart-doc.json new file mode 100644 index 00000000..11509534 --- /dev/null +++ b/servers/boe-server-all/src/main/resources/smart-doc.json @@ -0,0 +1,7 @@ +{ + "outPath": "src/main/resources/apidoc", + "isStrict": false, + "ignoreEmptyTag": true, + "createDebugPage": true, + "allInOne": true +} \ No newline at end of file