From c49b7d75327a7d4f405595da52fffca1ec98434f Mon Sep 17 00:00:00 2001 From: FatttSnake Date: Sat, 27 Apr 2024 16:54:37 +0800 Subject: [PATCH] Docs(Kdoc): Optimize kdoc --- .../service/permission/impl/AuthenticationServiceImpl.kt | 6 ++++++ .../api/service/permission/impl/RUserRoleServiceImpl.kt | 1 + .../api/service/permission/impl/UserDetailsServiceImpl.kt | 4 +++- .../api/service/permission/impl/UserInfoServiceImpl.kt | 1 + .../oxygen/api/service/system/impl/EventLogServiceImpl.kt | 4 ++++ .../api/service/system/impl/SensitiveWordServiceImpl.kt | 4 ++++ .../api/service/system/impl/StatisticsLogServiceImpl.kt | 4 ++++ .../oxygen/api/service/system/impl/StatisticsServiceImpl.kt | 4 ++++ .../oxygen/api/service/tool/impl/ManagementServiceImpl.kt | 3 ++- .../oxygen/api/service/tool/impl/ToolBaseServiceImpl.kt | 1 + .../oxygen/api/service/tool/impl/ToolTemplateServiceImpl.kt | 2 ++ 11 files changed, 32 insertions(+), 2 deletions(-) diff --git a/src/main/kotlin/top/fatweb/oxygen/api/service/permission/impl/AuthenticationServiceImpl.kt b/src/main/kotlin/top/fatweb/oxygen/api/service/permission/impl/AuthenticationServiceImpl.kt index afdbb73..fdb418c 100644 --- a/src/main/kotlin/top/fatweb/oxygen/api/service/permission/impl/AuthenticationServiceImpl.kt +++ b/src/main/kotlin/top/fatweb/oxygen/api/service/permission/impl/AuthenticationServiceImpl.kt @@ -46,9 +46,15 @@ import java.util.* * * @author FatttSnake, fatttsnake@gmail.com * @since 1.0.0 + * @see VelocityEngine * @see AuthenticationManager + * @see PasswordEncoder * @see RedisUtil + * @see TurnstileApi * @see IUserService + * @see IUserInfoService + * @see ISensitiveWordService + * @see IAvatarService * @see IAuthenticationService */ @Service diff --git a/src/main/kotlin/top/fatweb/oxygen/api/service/permission/impl/RUserRoleServiceImpl.kt b/src/main/kotlin/top/fatweb/oxygen/api/service/permission/impl/RUserRoleServiceImpl.kt index 86f705c..3a9d0b2 100644 --- a/src/main/kotlin/top/fatweb/oxygen/api/service/permission/impl/RUserRoleServiceImpl.kt +++ b/src/main/kotlin/top/fatweb/oxygen/api/service/permission/impl/RUserRoleServiceImpl.kt @@ -13,6 +13,7 @@ import top.fatweb.oxygen.api.service.permission.IRUserRoleService * @since 1.0.0 * @see ServiceImpl * @see RUserRoleMapper + * @see RUserRole * @see IRUserRoleService */ @Service diff --git a/src/main/kotlin/top/fatweb/oxygen/api/service/permission/impl/UserDetailsServiceImpl.kt b/src/main/kotlin/top/fatweb/oxygen/api/service/permission/impl/UserDetailsServiceImpl.kt index 95a3498..ad82c48 100644 --- a/src/main/kotlin/top/fatweb/oxygen/api/service/permission/impl/UserDetailsServiceImpl.kt +++ b/src/main/kotlin/top/fatweb/oxygen/api/service/permission/impl/UserDetailsServiceImpl.kt @@ -16,7 +16,9 @@ import top.fatweb.oxygen.api.service.permission.IUserService * @see UserDetailsService */ @Service -class UserDetailsServiceImpl(val userService: IUserService) : UserDetailsService { +class UserDetailsServiceImpl( + private val userService: IUserService +) : UserDetailsService { override fun loadUserByUsername(account: String): UserDetails { val user = userService.getUserWithPowerByAccount(account) user ?: throw UserNotFoundException() diff --git a/src/main/kotlin/top/fatweb/oxygen/api/service/permission/impl/UserInfoServiceImpl.kt b/src/main/kotlin/top/fatweb/oxygen/api/service/permission/impl/UserInfoServiceImpl.kt index c9ceb1e..2e92d4b 100644 --- a/src/main/kotlin/top/fatweb/oxygen/api/service/permission/impl/UserInfoServiceImpl.kt +++ b/src/main/kotlin/top/fatweb/oxygen/api/service/permission/impl/UserInfoServiceImpl.kt @@ -13,6 +13,7 @@ import top.fatweb.oxygen.api.service.permission.IUserInfoService * @since 1.0.0 * @see ServiceImpl * @see UserInfoMapper + * @see UserInfo * @see IUserInfoService */ @Service diff --git a/src/main/kotlin/top/fatweb/oxygen/api/service/system/impl/EventLogServiceImpl.kt b/src/main/kotlin/top/fatweb/oxygen/api/service/system/impl/EventLogServiceImpl.kt index b2d51d6..37ff2df 100644 --- a/src/main/kotlin/top/fatweb/oxygen/api/service/system/impl/EventLogServiceImpl.kt +++ b/src/main/kotlin/top/fatweb/oxygen/api/service/system/impl/EventLogServiceImpl.kt @@ -17,6 +17,10 @@ import top.fatweb.oxygen.api.service.system.IEventLogService * * @author FatttSnake, fatttsnake@gmail.com * @since 1.0.0 + * @see ServiceImpl + * @see EventLogMapper + * @see EventLog + * @see IEventLogService */ @DS("sqlite") @Service diff --git a/src/main/kotlin/top/fatweb/oxygen/api/service/system/impl/SensitiveWordServiceImpl.kt b/src/main/kotlin/top/fatweb/oxygen/api/service/system/impl/SensitiveWordServiceImpl.kt index e973d23..f60c2f0 100644 --- a/src/main/kotlin/top/fatweb/oxygen/api/service/system/impl/SensitiveWordServiceImpl.kt +++ b/src/main/kotlin/top/fatweb/oxygen/api/service/system/impl/SensitiveWordServiceImpl.kt @@ -20,6 +20,10 @@ import top.fatweb.oxygen.api.vo.system.SensitiveWordVo * * @author FatttSnake, fatttsnake@gmail.com * @since 1.0.0 + * @see ServiceImpl + * @see SensitiveWordMapper + * @see SensitiveWord + * @see ISensitiveWordService */ @Service class SensitiveWordServiceImpl : ServiceImpl(), ISensitiveWordService { diff --git a/src/main/kotlin/top/fatweb/oxygen/api/service/system/impl/StatisticsLogServiceImpl.kt b/src/main/kotlin/top/fatweb/oxygen/api/service/system/impl/StatisticsLogServiceImpl.kt index b7faec6..1c3f1c8 100644 --- a/src/main/kotlin/top/fatweb/oxygen/api/service/system/impl/StatisticsLogServiceImpl.kt +++ b/src/main/kotlin/top/fatweb/oxygen/api/service/system/impl/StatisticsLogServiceImpl.kt @@ -12,6 +12,10 @@ import top.fatweb.oxygen.api.service.system.IStatisticsLogService * * @author FatttSnake, fatttsnake@gmail.com * @since 1.0.0 + * @see ServiceImpl + * @see StatisticsLogMapper + * @see StatisticsLog + * @see IStatisticsLogService */ @DS("sqlite") @Service diff --git a/src/main/kotlin/top/fatweb/oxygen/api/service/system/impl/StatisticsServiceImpl.kt b/src/main/kotlin/top/fatweb/oxygen/api/service/system/impl/StatisticsServiceImpl.kt index ae264a7..a5f936e 100644 --- a/src/main/kotlin/top/fatweb/oxygen/api/service/system/impl/StatisticsServiceImpl.kt +++ b/src/main/kotlin/top/fatweb/oxygen/api/service/system/impl/StatisticsServiceImpl.kt @@ -29,6 +29,10 @@ import java.util.concurrent.TimeUnit * * @author FatttSnake, fatttsnake@gmail.com * @since 1.0.0 + * @see RedisUtil + * @see IStatisticsLogService + * @see IEventLogService + * @see IStatisticsService */ @Service class StatisticsServiceImpl( diff --git a/src/main/kotlin/top/fatweb/oxygen/api/service/tool/impl/ManagementServiceImpl.kt b/src/main/kotlin/top/fatweb/oxygen/api/service/tool/impl/ManagementServiceImpl.kt index 96ac255..4810eae 100644 --- a/src/main/kotlin/top/fatweb/oxygen/api/service/tool/impl/ManagementServiceImpl.kt +++ b/src/main/kotlin/top/fatweb/oxygen/api/service/tool/impl/ManagementServiceImpl.kt @@ -29,6 +29,8 @@ import java.time.ZoneOffset * * @author FatttSnake, fatttsnake@gmail.com * @since 1.0.0 + * @see IToolDataService + * @see IRToolCategoryService * @see ServiceImpl * @see ManagementMapper * @see Tool @@ -123,5 +125,4 @@ class ManagementServiceImpl( return this.removeById(id) } - } \ No newline at end of file diff --git a/src/main/kotlin/top/fatweb/oxygen/api/service/tool/impl/ToolBaseServiceImpl.kt b/src/main/kotlin/top/fatweb/oxygen/api/service/tool/impl/ToolBaseServiceImpl.kt index fc2fb9d..237ba10 100644 --- a/src/main/kotlin/top/fatweb/oxygen/api/service/tool/impl/ToolBaseServiceImpl.kt +++ b/src/main/kotlin/top/fatweb/oxygen/api/service/tool/impl/ToolBaseServiceImpl.kt @@ -24,6 +24,7 @@ import top.fatweb.oxygen.api.vo.tool.ToolBaseVo * * @author FatttSnake, fatttsnake@gmail.com * @since 1.0.0 + * @see IToolDataService * @see ServiceImpl * @see ToolBaseMapper * @see ToolBase diff --git a/src/main/kotlin/top/fatweb/oxygen/api/service/tool/impl/ToolTemplateServiceImpl.kt b/src/main/kotlin/top/fatweb/oxygen/api/service/tool/impl/ToolTemplateServiceImpl.kt index 45ee0ae..34195b9 100644 --- a/src/main/kotlin/top/fatweb/oxygen/api/service/tool/impl/ToolTemplateServiceImpl.kt +++ b/src/main/kotlin/top/fatweb/oxygen/api/service/tool/impl/ToolTemplateServiceImpl.kt @@ -24,6 +24,8 @@ import top.fatweb.oxygen.api.vo.tool.ToolTemplateVo * * @author FatttSnake, fatttsnake@gmail.com * @since 1.0.0 + * @see IToolDataService + * @see IToolBaseService * @see ServiceImpl * @see ToolTemplateMapper * @see ToolTemplate