From ea2868e87ad5af62cef55bb36053d3f74e45ad2b Mon Sep 17 00:00:00 2001 From: FatttSnake Date: Wed, 24 Jan 2024 16:16:18 +0800 Subject: [PATCH] Optimize kdoc --- .../permission/AuthenticationController.kt | 2 +- .../controller/permission/GroupController.kt | 4 ++-- .../controller/permission/PowerController.kt | 2 +- .../controller/permission/RoleController.kt | 2 +- .../controller/permission/UserController.kt | 2 +- .../controller/system/SettingsController.kt | 2 +- .../controller/system/StatisticsController.kt | 2 +- .../api/controller/system/SysLogController.kt | 2 +- .../api/converter/system/SettingsConverter.kt | 20 +++++++++++++++++++ .../oxygen/api/entity/permission/User.kt | 2 +- .../api/vo/permission/UserWithPowerInfoVo.kt | 2 +- 11 files changed, 31 insertions(+), 11 deletions(-) diff --git a/src/main/kotlin/top/fatweb/oxygen/api/controller/permission/AuthenticationController.kt b/src/main/kotlin/top/fatweb/oxygen/api/controller/permission/AuthenticationController.kt index d443136..1d21a2c 100644 --- a/src/main/kotlin/top/fatweb/oxygen/api/controller/permission/AuthenticationController.kt +++ b/src/main/kotlin/top/fatweb/oxygen/api/controller/permission/AuthenticationController.kt @@ -108,7 +108,7 @@ class AuthenticationController( * * @param request * @param retrieveParam Retrieve parameters - * @return Response object include retrieve result + * @return Response object includes retrieve result * @author FatttSnake, fatttsnake@gmail.com * @since 1.0.0 * @see HttpServletRequest diff --git a/src/main/kotlin/top/fatweb/oxygen/api/controller/permission/GroupController.kt b/src/main/kotlin/top/fatweb/oxygen/api/controller/permission/GroupController.kt index 563345d..664a928 100644 --- a/src/main/kotlin/top/fatweb/oxygen/api/controller/permission/GroupController.kt +++ b/src/main/kotlin/top/fatweb/oxygen/api/controller/permission/GroupController.kt @@ -14,7 +14,7 @@ import top.fatweb.oxygen.api.vo.permission.GroupWithRoleVo import top.fatweb.oxygen.api.vo.permission.base.GroupVo /** - * Group controller + * Group management controller * * @author FatttSnake, fatttsnake@gmail.com * @since 1.0.0 @@ -28,7 +28,7 @@ class GroupController( * Get group by ID * * @param id Group ID - * @return Response object includes group info + * @return Response object includes group information * @author FatttSnake, fatttsnake@gmail.com * @since 1.0.0 * @see ResponseResult diff --git a/src/main/kotlin/top/fatweb/oxygen/api/controller/permission/PowerController.kt b/src/main/kotlin/top/fatweb/oxygen/api/controller/permission/PowerController.kt index 4fcfa08..310f809 100644 --- a/src/main/kotlin/top/fatweb/oxygen/api/controller/permission/PowerController.kt +++ b/src/main/kotlin/top/fatweb/oxygen/api/controller/permission/PowerController.kt @@ -9,7 +9,7 @@ import top.fatweb.oxygen.api.service.permission.IPowerService import top.fatweb.oxygen.api.vo.permission.PowerSetVo /** - * Power controller + * Power management controller * * @author FatttSnake, fatttsnake@gmail.com * @since 1.0.0 diff --git a/src/main/kotlin/top/fatweb/oxygen/api/controller/permission/RoleController.kt b/src/main/kotlin/top/fatweb/oxygen/api/controller/permission/RoleController.kt index 0a45bb8..77144e2 100644 --- a/src/main/kotlin/top/fatweb/oxygen/api/controller/permission/RoleController.kt +++ b/src/main/kotlin/top/fatweb/oxygen/api/controller/permission/RoleController.kt @@ -14,7 +14,7 @@ import top.fatweb.oxygen.api.vo.permission.RoleWithPowerVo import top.fatweb.oxygen.api.vo.permission.base.RoleVo /** - * Role controller + * Role management controller * * @author FatttSnake, fatttsnake@gmail.com * @since 1.0.0 diff --git a/src/main/kotlin/top/fatweb/oxygen/api/controller/permission/UserController.kt b/src/main/kotlin/top/fatweb/oxygen/api/controller/permission/UserController.kt index 6c23fa7..af08ef3 100644 --- a/src/main/kotlin/top/fatweb/oxygen/api/controller/permission/UserController.kt +++ b/src/main/kotlin/top/fatweb/oxygen/api/controller/permission/UserController.kt @@ -15,7 +15,7 @@ import top.fatweb.oxygen.api.vo.permission.UserWithPowerInfoVo import top.fatweb.oxygen.api.vo.permission.UserWithRoleInfoVo /** - * User controller + * User management controller * * @author FatttSnake, fatttsnake@gmail.com * @since 1.0.0 diff --git a/src/main/kotlin/top/fatweb/oxygen/api/controller/system/SettingsController.kt b/src/main/kotlin/top/fatweb/oxygen/api/controller/system/SettingsController.kt index 451a7d5..68adf8e 100644 --- a/src/main/kotlin/top/fatweb/oxygen/api/controller/system/SettingsController.kt +++ b/src/main/kotlin/top/fatweb/oxygen/api/controller/system/SettingsController.kt @@ -20,7 +20,7 @@ import top.fatweb.oxygen.api.vo.system.MailSettingsVo import top.fatweb.oxygen.api.vo.system.SensitiveWordVo /** - * System settings controller + * System settings management controller * * @author FatttSnake, fatttsnake@gmail.com * @since 1.0.0 diff --git a/src/main/kotlin/top/fatweb/oxygen/api/controller/system/StatisticsController.kt b/src/main/kotlin/top/fatweb/oxygen/api/controller/system/StatisticsController.kt index f21802b..4826755 100644 --- a/src/main/kotlin/top/fatweb/oxygen/api/controller/system/StatisticsController.kt +++ b/src/main/kotlin/top/fatweb/oxygen/api/controller/system/StatisticsController.kt @@ -11,7 +11,7 @@ import top.fatweb.oxygen.api.service.system.IStatisticsService import top.fatweb.oxygen.api.vo.system.* /** - * Statistics controller + * Statistics management controller * * @author FatttSnake, fatttsnake@gmail.com * @since 1.0.0 diff --git a/src/main/kotlin/top/fatweb/oxygen/api/controller/system/SysLogController.kt b/src/main/kotlin/top/fatweb/oxygen/api/controller/system/SysLogController.kt index 01c37cd..894fe05 100644 --- a/src/main/kotlin/top/fatweb/oxygen/api/controller/system/SysLogController.kt +++ b/src/main/kotlin/top/fatweb/oxygen/api/controller/system/SysLogController.kt @@ -13,7 +13,7 @@ import top.fatweb.oxygen.api.vo.PageVo import top.fatweb.oxygen.api.vo.system.SysLogVo /** - * System log controller + * System log viewer controller * * @author FatttSnake, fatttsnake@gmail.com * @since 1.0.0 diff --git a/src/main/kotlin/top/fatweb/oxygen/api/converter/system/SettingsConverter.kt b/src/main/kotlin/top/fatweb/oxygen/api/converter/system/SettingsConverter.kt index a9f29bb..2d7f717 100644 --- a/src/main/kotlin/top/fatweb/oxygen/api/converter/system/SettingsConverter.kt +++ b/src/main/kotlin/top/fatweb/oxygen/api/converter/system/SettingsConverter.kt @@ -11,6 +11,16 @@ import top.fatweb.oxygen.api.vo.system.SensitiveWordVo * @since 1.0.0 */ object SettingsConverter { + /** + * Convert SensitiveWord object into SensitiveWordVo object + * + * @param sensitiveWord SensitiveWord object + * @return SensitiveWordVo object + * @author FatttSnake, fatttsnake@gmail.com + * @since 1.0.0 + * @see SensitiveWord + * @see SensitiveWordVo + */ fun sensitiveWordToSensitiveWordVo(sensitiveWord: SensitiveWord) = SensitiveWordVo( id = sensitiveWord.id, word = sensitiveWord.word, @@ -18,6 +28,16 @@ object SettingsConverter { enable = sensitiveWord.enable == 1 ) + /** + * Convert SensitiveWordAddParam object into SensitiveWord object + * + * @param sensitiveWordAddParam SensitiveWordAddParam object + * @return SensitiveWord object + * @author FatttSnake, fatttsnake@gmail.com + * @since 1.0.0 + * @see SensitiveWordAddParam + * @see SensitiveWord + */ fun sensitiveWordAddParamToSensitiveWord(sensitiveWordAddParam: SensitiveWordAddParam) = SensitiveWord().apply { word = sensitiveWordAddParam.word useFor = sensitiveWordAddParam.useFor.map(SensitiveWord.Use::code).toSet() diff --git a/src/main/kotlin/top/fatweb/oxygen/api/entity/permission/User.kt b/src/main/kotlin/top/fatweb/oxygen/api/entity/permission/User.kt index 905178f..11324c6 100644 --- a/src/main/kotlin/top/fatweb/oxygen/api/entity/permission/User.kt +++ b/src/main/kotlin/top/fatweb/oxygen/api/entity/permission/User.kt @@ -181,7 +181,7 @@ class User() : Serializable { var version: Int? = null /** - * User info + * User information * * @author FatttSnake, fatttsnake@gmail.com * @since 1.0.0 diff --git a/src/main/kotlin/top/fatweb/oxygen/api/vo/permission/UserWithPowerInfoVo.kt b/src/main/kotlin/top/fatweb/oxygen/api/vo/permission/UserWithPowerInfoVo.kt index 7fd460c..4616b50 100644 --- a/src/main/kotlin/top/fatweb/oxygen/api/vo/permission/UserWithPowerInfoVo.kt +++ b/src/main/kotlin/top/fatweb/oxygen/api/vo/permission/UserWithPowerInfoVo.kt @@ -119,7 +119,7 @@ data class UserWithPowerInfoVo( val lastLoginIp: String?, /** - * Update time + * Create time * * @author FatttSnake, fatttsnake@gmail.com * @since 1.0.0