Commit be778ba37037d7557c8dcb2355115e87414f85e2
1 parent
52d48fa6
修复参数注释
Showing
8 changed files
with
54 additions
and
54 deletions
ruoyi-common/src/main/java/com/ruoyi/common/core/redis/RedisCache.java
| ... | ... | @@ -13,7 +13,7 @@ import org.springframework.stereotype.Component; |
| 13 | 13 | |
| 14 | 14 | /** |
| 15 | 15 | * spring redis 工具类 |
| 16 | - * | |
| 16 | + * | |
| 17 | 17 | * @author ruoyi |
| 18 | 18 | **/ |
| 19 | 19 | @SuppressWarnings(value = { "unchecked", "rawtypes" }) |
| ... | ... | @@ -109,7 +109,7 @@ public class RedisCache |
| 109 | 109 | * 缓存List数据 |
| 110 | 110 | * |
| 111 | 111 | * @param key 缓存的键值 |
| 112 | - * @param values 待缓存的List数据 | |
| 112 | + * @param dataList 待缓存的List数据 | |
| 113 | 113 | * @return 缓存的对象 |
| 114 | 114 | */ |
| 115 | 115 | public <T> long setCacheList(final String key, final List<T> dataList) |
| ... | ... | @@ -216,7 +216,7 @@ public class RedisCache |
| 216 | 216 | |
| 217 | 217 | /** |
| 218 | 218 | * 获得缓存的基本对象列表 |
| 219 | - * | |
| 219 | + * | |
| 220 | 220 | * @param pattern 字符串前缀 |
| 221 | 221 | * @return 对象列表 |
| 222 | 222 | */ | ... | ... |
ruoyi-common/src/main/java/com/ruoyi/common/utils/file/FileUploadUtils.java
| ... | ... | @@ -15,7 +15,7 @@ import com.ruoyi.common.utils.uuid.IdUtils; |
| 15 | 15 | |
| 16 | 16 | /** |
| 17 | 17 | * 文件上传工具类 |
| 18 | - * | |
| 18 | + * | |
| 19 | 19 | * @author ruoyi |
| 20 | 20 | */ |
| 21 | 21 | public class FileUploadUtils |
| ... | ... | @@ -89,7 +89,7 @@ public class FileUploadUtils |
| 89 | 89 | * |
| 90 | 90 | * @param baseDir 相对应用的基目录 |
| 91 | 91 | * @param file 上传的文件 |
| 92 | - * @param extension 上传文件类型 | |
| 92 | + * @param allowedExtension 上传文件类型 | |
| 93 | 93 | * @return 返回上传成功的文件名 |
| 94 | 94 | * @throws FileSizeLimitExceededException 如果超出最大大小 |
| 95 | 95 | * @throws FileNameLengthLimitExceededException 文件名太长 |
| ... | ... | @@ -215,7 +215,7 @@ public class FileUploadUtils |
| 215 | 215 | |
| 216 | 216 | /** |
| 217 | 217 | * 获取文件名的后缀 |
| 218 | - * | |
| 218 | + * | |
| 219 | 219 | * @param file 表单文件 |
| 220 | 220 | * @return 后缀名 |
| 221 | 221 | */ |
| ... | ... | @@ -228,4 +228,4 @@ public class FileUploadUtils |
| 228 | 228 | } |
| 229 | 229 | return extension; |
| 230 | 230 | } |
| 231 | -} | |
| 232 | 231 | \ No newline at end of file |
| 232 | +} | ... | ... |
ruoyi-framework/src/main/java/com/ruoyi/framework/aspectj/DataScopeAspect.java
| ... | ... | @@ -20,7 +20,7 @@ import com.ruoyi.framework.web.service.TokenService; |
| 20 | 20 | |
| 21 | 21 | /** |
| 22 | 22 | * 数据过滤处理 |
| 23 | - * | |
| 23 | + * | |
| 24 | 24 | * @author ruoyi |
| 25 | 25 | */ |
| 26 | 26 | @Aspect |
| ... | ... | @@ -93,10 +93,10 @@ public class DataScopeAspect |
| 93 | 93 | |
| 94 | 94 | /** |
| 95 | 95 | * 数据范围过滤 |
| 96 | - * | |
| 96 | + * | |
| 97 | 97 | * @param joinPoint 切点 |
| 98 | 98 | * @param user 用户 |
| 99 | - * @param alias 别名 | |
| 99 | + * @param userAlias 别名 | |
| 100 | 100 | */ |
| 101 | 101 | public static void dataScopeFilter(JoinPoint joinPoint, SysUser user, String deptAlias, String userAlias) |
| 102 | 102 | { | ... | ... |
ruoyi-framework/src/main/java/com/ruoyi/framework/interceptor/RepeatSubmitInterceptor.java
| ... | ... | @@ -13,7 +13,7 @@ import com.ruoyi.common.utils.ServletUtils; |
| 13 | 13 | |
| 14 | 14 | /** |
| 15 | 15 | * 防止重复提交拦截器 |
| 16 | - * | |
| 16 | + * | |
| 17 | 17 | * @author ruoyi |
| 18 | 18 | */ |
| 19 | 19 | @Component |
| ... | ... | @@ -46,8 +46,8 @@ public abstract class RepeatSubmitInterceptor extends HandlerInterceptorAdapter |
| 46 | 46 | |
| 47 | 47 | /** |
| 48 | 48 | * 验证是否重复提交由子类实现具体的防重复提交的规则 |
| 49 | - * | |
| 50 | - * @param httpServletRequest | |
| 49 | + * | |
| 50 | + * @param request | |
| 51 | 51 | * @return |
| 52 | 52 | * @throws Exception |
| 53 | 53 | */ | ... | ... |
ruoyi-framework/src/main/java/com/ruoyi/framework/web/service/TokenService.java
| ... | ... | @@ -22,7 +22,7 @@ import io.jsonwebtoken.SignatureAlgorithm; |
| 22 | 22 | |
| 23 | 23 | /** |
| 24 | 24 | * token验证处理 |
| 25 | - * | |
| 25 | + * | |
| 26 | 26 | * @author ruoyi |
| 27 | 27 | */ |
| 28 | 28 | @Component |
| ... | ... | @@ -51,7 +51,7 @@ public class TokenService |
| 51 | 51 | |
| 52 | 52 | /** |
| 53 | 53 | * 获取用户身份信息 |
| 54 | - * | |
| 54 | + * | |
| 55 | 55 | * @return 用户信息 |
| 56 | 56 | */ |
| 57 | 57 | public LoginUser getLoginUser(HttpServletRequest request) |
| ... | ... | @@ -95,7 +95,7 @@ public class TokenService |
| 95 | 95 | |
| 96 | 96 | /** |
| 97 | 97 | * 创建令牌 |
| 98 | - * | |
| 98 | + * | |
| 99 | 99 | * @param loginUser 用户信息 |
| 100 | 100 | * @return 令牌 |
| 101 | 101 | */ |
| ... | ... | @@ -113,8 +113,8 @@ public class TokenService |
| 113 | 113 | |
| 114 | 114 | /** |
| 115 | 115 | * 验证令牌有效期,相差不足20分钟,自动刷新缓存 |
| 116 | - * | |
| 117 | - * @param token 令牌 | |
| 116 | + * | |
| 117 | + * @param loginUser | |
| 118 | 118 | * @return 令牌 |
| 119 | 119 | */ |
| 120 | 120 | public void verifyToken(LoginUser loginUser) |
| ... | ... | @@ -129,7 +129,7 @@ public class TokenService |
| 129 | 129 | |
| 130 | 130 | /** |
| 131 | 131 | * 刷新令牌有效期 |
| 132 | - * | |
| 132 | + * | |
| 133 | 133 | * @param loginUser 登录信息 |
| 134 | 134 | */ |
| 135 | 135 | public void refreshToken(LoginUser loginUser) |
| ... | ... | @@ -140,10 +140,10 @@ public class TokenService |
| 140 | 140 | String userKey = getTokenKey(loginUser.getToken()); |
| 141 | 141 | redisCache.setCacheObject(userKey, loginUser, expireTime, TimeUnit.MINUTES); |
| 142 | 142 | } |
| 143 | - | |
| 143 | + | |
| 144 | 144 | /** |
| 145 | 145 | * 设置用户代理信息 |
| 146 | - * | |
| 146 | + * | |
| 147 | 147 | * @param loginUser 登录信息 |
| 148 | 148 | */ |
| 149 | 149 | public void setUserAgent(LoginUser loginUser) |
| ... | ... | @@ -155,7 +155,7 @@ public class TokenService |
| 155 | 155 | loginUser.setBrowser(userAgent.getBrowser().getName()); |
| 156 | 156 | loginUser.setOs(userAgent.getOperatingSystem().getName()); |
| 157 | 157 | } |
| 158 | - | |
| 158 | + | |
| 159 | 159 | /** |
| 160 | 160 | * 从数据声明生成令牌 |
| 161 | 161 | * | ... | ... |
ruoyi-generator/src/main/java/com/ruoyi/generator/util/VelocityUtils.java
| ... | ... | @@ -24,7 +24,7 @@ public class VelocityUtils |
| 24 | 24 | |
| 25 | 25 | /** |
| 26 | 26 | * 设置模板变量信息 |
| 27 | - * | |
| 27 | + * | |
| 28 | 28 | * @return 模板列表 |
| 29 | 29 | */ |
| 30 | 30 | public static VelocityContext prepareContext(GenTable genTable) |
| ... | ... | @@ -93,7 +93,7 @@ public class VelocityUtils |
| 93 | 93 | |
| 94 | 94 | /** |
| 95 | 95 | * 获取模板信息 |
| 96 | - * | |
| 96 | + * | |
| 97 | 97 | * @return 模板列表 |
| 98 | 98 | */ |
| 99 | 99 | public static List<String> getTemplateList(String tplCategory) |
| ... | ... | @@ -183,7 +183,7 @@ public class VelocityUtils |
| 183 | 183 | |
| 184 | 184 | /** |
| 185 | 185 | * 获取包前缀 |
| 186 | - * | |
| 186 | + * | |
| 187 | 187 | * @param packageName 包名称 |
| 188 | 188 | * @return 包前缀名称 |
| 189 | 189 | */ |
| ... | ... | @@ -196,8 +196,8 @@ public class VelocityUtils |
| 196 | 196 | |
| 197 | 197 | /** |
| 198 | 198 | * 根据列类型获取导入包 |
| 199 | - * | |
| 200 | - * @param column 列集合 | |
| 199 | + * | |
| 200 | + * @param columns 列集合 | |
| 201 | 201 | * @return 返回需要导入的包列表 |
| 202 | 202 | */ |
| 203 | 203 | public static HashSet<String> getImportList(List<GenTableColumn> columns) |
| ... | ... | @@ -220,7 +220,7 @@ public class VelocityUtils |
| 220 | 220 | |
| 221 | 221 | /** |
| 222 | 222 | * 获取权限前缀 |
| 223 | - * | |
| 223 | + * | |
| 224 | 224 | * @param moduleName 模块名称 |
| 225 | 225 | * @param businessName 业务名称 |
| 226 | 226 | * @return 返回权限前缀 |
| ... | ... | @@ -233,8 +233,8 @@ public class VelocityUtils |
| 233 | 233 | |
| 234 | 234 | /** |
| 235 | 235 | * 获取上级菜单ID字段 |
| 236 | - * | |
| 237 | - * @param options 生成其他选项 | |
| 236 | + * | |
| 237 | + * @param paramsObj 生成其他选项 | |
| 238 | 238 | * @return 上级菜单ID字段 |
| 239 | 239 | */ |
| 240 | 240 | public static String getParentMenuId(JSONObject paramsObj) |
| ... | ... | @@ -248,8 +248,8 @@ public class VelocityUtils |
| 248 | 248 | |
| 249 | 249 | /** |
| 250 | 250 | * 获取树编码 |
| 251 | - * | |
| 252 | - * @param options 生成其他选项 | |
| 251 | + * | |
| 252 | + * @param paramsObj 生成其他选项 | |
| 253 | 253 | * @return 树编码 |
| 254 | 254 | */ |
| 255 | 255 | public static String getTreecode(JSONObject paramsObj) |
| ... | ... | @@ -263,8 +263,8 @@ public class VelocityUtils |
| 263 | 263 | |
| 264 | 264 | /** |
| 265 | 265 | * 获取树父编码 |
| 266 | - * | |
| 267 | - * @param options 生成其他选项 | |
| 266 | + * | |
| 267 | + * @param paramsObj 生成其他选项 | |
| 268 | 268 | * @return 树父编码 |
| 269 | 269 | */ |
| 270 | 270 | public static String getTreeParentCode(JSONObject paramsObj) |
| ... | ... | @@ -278,8 +278,8 @@ public class VelocityUtils |
| 278 | 278 | |
| 279 | 279 | /** |
| 280 | 280 | * 获取树名称 |
| 281 | - * | |
| 282 | - * @param options 生成其他选项 | |
| 281 | + * | |
| 282 | + * @param paramsObj 生成其他选项 | |
| 283 | 283 | * @return 树名称 |
| 284 | 284 | */ |
| 285 | 285 | public static String getTreeName(JSONObject paramsObj) |
| ... | ... | @@ -293,7 +293,7 @@ public class VelocityUtils |
| 293 | 293 | |
| 294 | 294 | /** |
| 295 | 295 | * 获取需要在哪一列上面显示展开按钮 |
| 296 | - * | |
| 296 | + * | |
| 297 | 297 | * @param genTable 业务表对象 |
| 298 | 298 | * @return 展开按钮列序号 |
| 299 | 299 | */ |
| ... | ... | @@ -317,4 +317,4 @@ public class VelocityUtils |
| 317 | 317 | } |
| 318 | 318 | return num; |
| 319 | 319 | } |
| 320 | -} | |
| 321 | 320 | \ No newline at end of file |
| 321 | +} | ... | ... |
ruoyi-quartz/src/main/java/com/ruoyi/quartz/util/AbstractQuartzJob.java
| ... | ... | @@ -66,7 +66,7 @@ public abstract class AbstractQuartzJob implements Job |
| 66 | 66 | * 执行后 |
| 67 | 67 | * |
| 68 | 68 | * @param context 工作执行上下文对象 |
| 69 | - * @param sysScheduleJob 系统计划任务 | |
| 69 | + * @param sysJob 系统计划任务 | |
| 70 | 70 | */ |
| 71 | 71 | protected void after(JobExecutionContext context, SysJob sysJob, Exception e) |
| 72 | 72 | { | ... | ... |
ruoyi-system/src/main/java/com/ruoyi/system/mapper/SysMenuMapper.java
| ... | ... | @@ -6,14 +6,14 @@ import com.ruoyi.common.core.domain.entity.SysMenu; |
| 6 | 6 | |
| 7 | 7 | /** |
| 8 | 8 | * 菜单表 数据层 |
| 9 | - * | |
| 9 | + * | |
| 10 | 10 | * @author ruoyi |
| 11 | 11 | */ |
| 12 | 12 | public interface SysMenuMapper |
| 13 | 13 | { |
| 14 | 14 | /** |
| 15 | 15 | * 查询系统菜单列表 |
| 16 | - * | |
| 16 | + * | |
| 17 | 17 | * @param menu 菜单信息 |
| 18 | 18 | * @return 菜单列表 |
| 19 | 19 | */ |
| ... | ... | @@ -21,14 +21,14 @@ public interface SysMenuMapper |
| 21 | 21 | |
| 22 | 22 | /** |
| 23 | 23 | * 根据用户所有权限 |
| 24 | - * | |
| 24 | + * | |
| 25 | 25 | * @return 权限列表 |
| 26 | 26 | */ |
| 27 | 27 | public List<String> selectMenuPerms(); |
| 28 | 28 | |
| 29 | 29 | /** |
| 30 | 30 | * 根据用户查询系统菜单列表 |
| 31 | - * | |
| 31 | + * | |
| 32 | 32 | * @param menu 菜单信息 |
| 33 | 33 | * @return 菜单列表 |
| 34 | 34 | */ |
| ... | ... | @@ -36,7 +36,7 @@ public interface SysMenuMapper |
| 36 | 36 | |
| 37 | 37 | /** |
| 38 | 38 | * 根据用户ID查询权限 |
| 39 | - * | |
| 39 | + * | |
| 40 | 40 | * @param userId 用户ID |
| 41 | 41 | * @return 权限列表 |
| 42 | 42 | */ |
| ... | ... | @@ -44,22 +44,22 @@ public interface SysMenuMapper |
| 44 | 44 | |
| 45 | 45 | /** |
| 46 | 46 | * 根据用户ID查询菜单 |
| 47 | - * | |
| 47 | + * | |
| 48 | 48 | * @return 菜单列表 |
| 49 | 49 | */ |
| 50 | 50 | public List<SysMenu> selectMenuTreeAll(); |
| 51 | 51 | |
| 52 | 52 | /** |
| 53 | 53 | * 根据用户ID查询菜单 |
| 54 | - * | |
| 55 | - * @param username 用户ID | |
| 54 | + * | |
| 55 | + * @param userId 用户ID | |
| 56 | 56 | * @return 菜单列表 |
| 57 | 57 | */ |
| 58 | 58 | public List<SysMenu> selectMenuTreeByUserId(Long userId); |
| 59 | 59 | |
| 60 | 60 | /** |
| 61 | 61 | * 根据角色ID查询菜单树信息 |
| 62 | - * | |
| 62 | + * | |
| 63 | 63 | * @param roleId 角色ID |
| 64 | 64 | * @return 选中菜单列表 |
| 65 | 65 | */ |
| ... | ... | @@ -67,7 +67,7 @@ public interface SysMenuMapper |
| 67 | 67 | |
| 68 | 68 | /** |
| 69 | 69 | * 根据菜单ID查询信息 |
| 70 | - * | |
| 70 | + * | |
| 71 | 71 | * @param menuId 菜单ID |
| 72 | 72 | * @return 菜单信息 |
| 73 | 73 | */ |
| ... | ... | @@ -75,7 +75,7 @@ public interface SysMenuMapper |
| 75 | 75 | |
| 76 | 76 | /** |
| 77 | 77 | * 是否存在菜单子节点 |
| 78 | - * | |
| 78 | + * | |
| 79 | 79 | * @param menuId 菜单ID |
| 80 | 80 | * @return 结果 |
| 81 | 81 | */ |
| ... | ... | @@ -83,7 +83,7 @@ public interface SysMenuMapper |
| 83 | 83 | |
| 84 | 84 | /** |
| 85 | 85 | * 新增菜单信息 |
| 86 | - * | |
| 86 | + * | |
| 87 | 87 | * @param menu 菜单信息 |
| 88 | 88 | * @return 结果 |
| 89 | 89 | */ |
| ... | ... | @@ -91,7 +91,7 @@ public interface SysMenuMapper |
| 91 | 91 | |
| 92 | 92 | /** |
| 93 | 93 | * 修改菜单信息 |
| 94 | - * | |
| 94 | + * | |
| 95 | 95 | * @param menu 菜单信息 |
| 96 | 96 | * @return 结果 |
| 97 | 97 | */ |
| ... | ... | @@ -99,7 +99,7 @@ public interface SysMenuMapper |
| 99 | 99 | |
| 100 | 100 | /** |
| 101 | 101 | * 删除菜单管理信息 |
| 102 | - * | |
| 102 | + * | |
| 103 | 103 | * @param menuId 菜单ID |
| 104 | 104 | * @return 结果 |
| 105 | 105 | */ |
| ... | ... | @@ -107,7 +107,7 @@ public interface SysMenuMapper |
| 107 | 107 | |
| 108 | 108 | /** |
| 109 | 109 | * 校验菜单名称是否唯一 |
| 110 | - * | |
| 110 | + * | |
| 111 | 111 | * @param menuName 菜单名称 |
| 112 | 112 | * @param parentId 父菜单ID |
| 113 | 113 | * @return 结果 | ... | ... |