Docs(Kdoc): Optimize kdoc

This commit is contained in:
2024-04-27 16:54:37 +08:00
parent 38e0c90ce2
commit c49b7d7532
11 changed files with 32 additions and 2 deletions

View File

@@ -46,9 +46,15 @@ import java.util.*
* *
* @author FatttSnake, fatttsnake@gmail.com * @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0 * @since 1.0.0
* @see VelocityEngine
* @see AuthenticationManager * @see AuthenticationManager
* @see PasswordEncoder
* @see RedisUtil * @see RedisUtil
* @see TurnstileApi
* @see IUserService * @see IUserService
* @see IUserInfoService
* @see ISensitiveWordService
* @see IAvatarService
* @see IAuthenticationService * @see IAuthenticationService
*/ */
@Service @Service

View File

@@ -13,6 +13,7 @@ import top.fatweb.oxygen.api.service.permission.IRUserRoleService
* @since 1.0.0 * @since 1.0.0
* @see ServiceImpl * @see ServiceImpl
* @see RUserRoleMapper * @see RUserRoleMapper
* @see RUserRole
* @see IRUserRoleService * @see IRUserRoleService
*/ */
@Service @Service

View File

@@ -16,7 +16,9 @@ import top.fatweb.oxygen.api.service.permission.IUserService
* @see UserDetailsService * @see UserDetailsService
*/ */
@Service @Service
class UserDetailsServiceImpl(val userService: IUserService) : UserDetailsService { class UserDetailsServiceImpl(
private val userService: IUserService
) : UserDetailsService {
override fun loadUserByUsername(account: String): UserDetails { override fun loadUserByUsername(account: String): UserDetails {
val user = userService.getUserWithPowerByAccount(account) val user = userService.getUserWithPowerByAccount(account)
user ?: throw UserNotFoundException() user ?: throw UserNotFoundException()

View File

@@ -13,6 +13,7 @@ import top.fatweb.oxygen.api.service.permission.IUserInfoService
* @since 1.0.0 * @since 1.0.0
* @see ServiceImpl * @see ServiceImpl
* @see UserInfoMapper * @see UserInfoMapper
* @see UserInfo
* @see IUserInfoService * @see IUserInfoService
*/ */
@Service @Service

View File

@@ -17,6 +17,10 @@ import top.fatweb.oxygen.api.service.system.IEventLogService
* *
* @author FatttSnake, fatttsnake@gmail.com * @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0 * @since 1.0.0
* @see ServiceImpl
* @see EventLogMapper
* @see EventLog
* @see IEventLogService
*/ */
@DS("sqlite") @DS("sqlite")
@Service @Service

View File

@@ -20,6 +20,10 @@ import top.fatweb.oxygen.api.vo.system.SensitiveWordVo
* *
* @author FatttSnake, fatttsnake@gmail.com * @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0 * @since 1.0.0
* @see ServiceImpl
* @see SensitiveWordMapper
* @see SensitiveWord
* @see ISensitiveWordService
*/ */
@Service @Service
class SensitiveWordServiceImpl : ServiceImpl<SensitiveWordMapper, SensitiveWord>(), ISensitiveWordService { class SensitiveWordServiceImpl : ServiceImpl<SensitiveWordMapper, SensitiveWord>(), ISensitiveWordService {

View File

@@ -12,6 +12,10 @@ import top.fatweb.oxygen.api.service.system.IStatisticsLogService
* *
* @author FatttSnake, fatttsnake@gmail.com * @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0 * @since 1.0.0
* @see ServiceImpl
* @see StatisticsLogMapper
* @see StatisticsLog
* @see IStatisticsLogService
*/ */
@DS("sqlite") @DS("sqlite")
@Service @Service

View File

@@ -29,6 +29,10 @@ import java.util.concurrent.TimeUnit
* *
* @author FatttSnake, fatttsnake@gmail.com * @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0 * @since 1.0.0
* @see RedisUtil
* @see IStatisticsLogService
* @see IEventLogService
* @see IStatisticsService
*/ */
@Service @Service
class StatisticsServiceImpl( class StatisticsServiceImpl(

View File

@@ -29,6 +29,8 @@ import java.time.ZoneOffset
* *
* @author FatttSnake, fatttsnake@gmail.com * @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0 * @since 1.0.0
* @see IToolDataService
* @see IRToolCategoryService
* @see ServiceImpl * @see ServiceImpl
* @see ManagementMapper * @see ManagementMapper
* @see Tool * @see Tool
@@ -123,5 +125,4 @@ class ManagementServiceImpl(
return this.removeById(id) return this.removeById(id)
} }
} }

View File

@@ -24,6 +24,7 @@ import top.fatweb.oxygen.api.vo.tool.ToolBaseVo
* *
* @author FatttSnake, fatttsnake@gmail.com * @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0 * @since 1.0.0
* @see IToolDataService
* @see ServiceImpl * @see ServiceImpl
* @see ToolBaseMapper * @see ToolBaseMapper
* @see ToolBase * @see ToolBase

View File

@@ -24,6 +24,8 @@ import top.fatweb.oxygen.api.vo.tool.ToolTemplateVo
* *
* @author FatttSnake, fatttsnake@gmail.com * @author FatttSnake, fatttsnake@gmail.com
* @since 1.0.0 * @since 1.0.0
* @see IToolDataService
* @see IToolBaseService
* @see ServiceImpl * @see ServiceImpl
* @see ToolTemplateMapper * @see ToolTemplateMapper
* @see ToolTemplate * @see ToolTemplate