Optimize kdoc

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

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

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

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

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

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

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

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

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()

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

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