Add kdoc

src/main/kotlin/top/fatweb/api/converter/permission/RoleConverter.kt

@@ -4,7 +4,7 @@ import com.baomidou.mybatisplus.core.metadata.IPage
 import top.fatweb.api.entity.permission.Power
 import top.fatweb.api.entity.permission.Role
 import top.fatweb.api.param.permission.role.RoleAddParam
-import top.fatweb.api.param.permission.role.RoleChangeStatusParam
+import top.fatweb.api.param.permission.role.RoleUpdateStatusParam
 import top.fatweb.api.param.permission.role.RoleUpdateParam
 import top.fatweb.api.vo.PageVo
 import top.fatweb.api.vo.permission.base.RoleVo
@@ -17,6 +17,16 @@ import top.fatweb.api.vo.permission.RoleWithPowerVo
  * @since 1.0.0
  */
 object RoleConverter {
+    /**
+     * Convert Role object into RoleVo object
+     *
+     * @param role Role object
+     * @return RoleVo object
+     * @author FatttSnake, fatttsnake@gmail.com
+     * @since 1.0.0
+     * @see Role
+     * @see RoleVo
+     */
     fun roleToRoleVo(role: Role) = RoleVo(
         id = role.id,
         name = role.name,
@@ -25,6 +35,16 @@ object RoleConverter {
         updateTime = role.updateTime
     )
 
+    /**
+     * Convert Role object into RoleWithPowerVo object
+     *
+     * @param role Role object
+     * @return RoleWithPowerVo object
+     * @author FatttSnake, fatttsnake@gmail.com
+     * @since 1.0.0
+     * @see Role
+     * @see RoleWithPowerVo
+     */
     fun roleToRoleWithPowerVo(role: Role) = RoleWithPowerVo(
         id = role.id,
         name = role.name,
@@ -37,6 +57,18 @@ object RoleConverter {
         operations = role.operations?.map { OperationConverter.operationToOperationVo(it) }
     )
 
+    /**
+     * Convert IPage<Role> object into PageVo object
+     *
+     * @param rolePage IPage<Role> object
+     * @return PageVo<RoleWithPowerVo> object
+     * @author FatttSnake, fatttsnake@gmail.com
+     * @since 1.0.0
+     * @see IPage
+     * @see Role
+     * @see PageVo
+     * @see RoleWithPowerVo
+     */
     fun rolePageToRoleWithPowerPageVo(rolePage: IPage<Role>) = PageVo(
         total = rolePage.total,
         pages = rolePage.pages,
@@ -47,21 +79,51 @@ object RoleConverter {
         }
     )
 
+    /**
+     * Convert RoleAddParam object into Role object
+     *
+     * @param roleAddParam RoleAddParam object
+     * @return Role object
+     * @author FatttSnake, fatttsnake@gmail.com
+     * @since 1.0.0
+     * @see RoleAddParam
+     * @see Role
+     */
     fun roleAddParamToRole(roleAddParam: RoleAddParam) = Role().apply {
         name = roleAddParam.name
-        enable = if (roleAddParam.enable == true) 1 else 0
+        enable = if (roleAddParam.enable) 1 else 0
         powers = roleAddParam.powerIds?.map { Power().apply { id = it } }
     }
 
+    /**
+     * Convert RoleUpdateParam into Role object
+     *
+     * @param roleUpdateParam RoleUpdateParam object
+     * @return Role object
+     * @author FatttSnake, fatttsnake@gmail.com
+     * @since 1.0.0
+     * @see RoleUpdateParam
+     * @see Role
+     */
     fun roleUpdateParamToRole(roleUpdateParam: RoleUpdateParam) = Role().apply {
         id = roleUpdateParam.id
         name = roleUpdateParam.name
-        enable = if (roleUpdateParam.enable == true) 1 else 0
+        enable = if (roleUpdateParam.enable) 1 else 0
         powers = roleUpdateParam.powerIds?.map { Power().apply { id = it } }
     }
 
-    fun roleChangeStatusParamToRole(roleChangeStatusParam: RoleChangeStatusParam) = Role().apply {
-        id = roleChangeStatusParam.id
-        enable = if (roleChangeStatusParam.enable) 1 else 0
+    /**
+     * Convert RoleUpdateStatusParam object into Role object
+     *
+     * @param roleUpdateStatusParam RoleUpdateStatusParam object
+     * @return Role object
+     * @author FatttSnake, fatttsnake@gmail.com
+     * @since 1.0.0
+     * @see RoleUpdateStatusParam
+     * @see Role
+     */
+    fun roleUpdateStatusParamToRole(roleUpdateStatusParam: RoleUpdateStatusParam) = Role().apply {
+        id = roleUpdateStatusParam.id
+        enable = if (roleUpdateStatusParam.enable) 1 else 0
     }
 }