🔨 规范化注释.

This commit is contained in:
lijiahang
2024-06-07 16:05:26 +08:00
parent c39049e5f5
commit 2bd7dfd5b8
37 changed files with 534 additions and 248 deletions

View File

@@ -1,6 +1,5 @@
package com.orion.visor.module.infra.handler.preference.model;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
@@ -19,31 +18,49 @@ import lombok.NoArgsConstructor;
@AllArgsConstructor
public class SystemPreferenceModel implements PreferenceModel {
@Schema(description = "是否使用侧边菜单")
/**
* 是否使用侧边菜单
*/
private Boolean menu;
@Schema(description = "是否使用顶部菜单")
/**
* 是否使用顶部菜单
*/
private Boolean topMenu;
@Schema(description = "是否显示导航栏")
/**
* 是否显示导航栏
*/
private Boolean navbar;
@Schema(description = "是否显示页脚")
/**
* 是否显示页脚
*/
private Boolean footer;
@Schema(description = "是否开启多页签")
/**
* 是否开启多页签
*/
private Boolean tabBar;
@Schema(description = "是否开启色弱模式")
/**
* 是否开启色弱模式
*/
private Boolean colorWeak;
@Schema(description = "菜单宽度")
/**
* 菜单宽度
*/
private Integer menuWidth;
@Schema(description = "表格默认页数")
/**
* 表格默认页数
*/
private Integer defaultTablePageSize;
@Schema(description = "卡片默认页数")
/**
* 卡片默认页数
*/
private Integer defaultCardPageSize;
}

View File

@@ -2,7 +2,6 @@ package com.orion.visor.module.infra.handler.preference.model;
import com.alibaba.fastjson.JSONObject;
import com.orion.lang.able.IJsonObject;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
@@ -23,31 +22,49 @@ import java.util.List;
@AllArgsConstructor
public class TerminalPreferenceModel implements PreferenceModel {
@Schema(description = "新建连接类型")
/**
* 新建连接类型
*/
private String newConnectionType;
@Schema(description = "终端主题")
/**
* 终端主题
*/
private JSONObject theme;
@Schema(description = "显示设置")
/**
* 显示设置
*/
private JSONObject displaySetting;
@Schema(description = "操作栏设置")
/**
* 操作栏设置
*/
private JSONObject actionBarSetting;
@Schema(description = "右键菜单设置")
/**
* 右键菜单设置
*/
private List<String> rightMenuSetting;
@Schema(description = "交互设置")
/**
* 交互设置
*/
private JSONObject interactSetting;
@Schema(description = "插件设置")
/**
* 插件设置
*/
private JSONObject pluginsSetting;
@Schema(description = "会话设置")
/**
* 会话设置
*/
private JSONObject sessionSetting;
@Schema(description = "快捷键设置")
/**
* 快捷键设置
*/
private JSONObject shortcutSetting;
@Data
@@ -56,28 +73,44 @@ public class TerminalPreferenceModel implements PreferenceModel {
@AllArgsConstructor
public static class DisplaySettingModel implements IJsonObject {
@Schema(description = "字体样式")
/**
* 字体样式
*/
private String fontFamily;
@Schema(description = "字体大小")
/**
* 字体大小
*/
private Integer fontSize;
@Schema(description = "行高")
/**
* 行高
*/
private Double lineHeight;
@Schema(description = "字间距")
/**
* 字间距
*/
private Integer letterSpacing;
@Schema(description = "文本字重")
/**
* 文本字重
*/
private String fontWeight;
@Schema(description = "加粗字重")
/**
* 加粗字重
*/
private String fontWeightBold;
@Schema(description = "光标样式")
/**
* 光标样式
*/
private String cursorStyle;
@Schema(description = "光标闪烁")
/**
* 光标闪烁
*/
private Boolean cursorBlink;
}
@@ -88,34 +121,54 @@ public class TerminalPreferenceModel implements PreferenceModel {
@AllArgsConstructor
public static class InteractSettingModel implements IJsonObject {
@Schema(description = "快速滚动")
/**
* 快速滚动
*/
private Boolean fastScrollModifier;
@Schema(description = "点击移动光标")
/**
* 点击移动光标
*/
private Boolean altClickMovesCursor;
@Schema(description = "右键选中词条")
/**
* 右键选中词条
*/
private Boolean rightClickSelectsWord;
@Schema(description = "选中自动复制")
/**
* 选中自动复制
*/
private Boolean selectionChangeCopy;
@Schema(description = "复制去除空格")
/**
* 复制去除空格
*/
private Boolean copyAutoTrim;
@Schema(description = "粘贴去除空格")
/**
* 粘贴去除空格
*/
private Boolean pasteAutoTrim;
@Schema(description = "右键粘贴")
/**
* 右键粘贴
*/
private Boolean rightClickPaste;
@Schema(description = "启用右键菜单")
/**
* 启用右键菜单
*/
private Boolean enableRightClickMenu;
@Schema(description = "启用响铃")
/**
* 启用响铃
*/
private Boolean enableBell;
@Schema(description = "单词分隔符")
/**
* 单词分隔符
*/
private String wordSeparator;
}
@@ -126,16 +179,24 @@ public class TerminalPreferenceModel implements PreferenceModel {
@AllArgsConstructor
public static class PluginsSettingModel implements IJsonObject {
@Schema(description = "超链接插件")
/**
* 超链接插件
*/
private Boolean enableWeblinkPlugin;
@Schema(description = "WebGL 渲染插件")
/**
* WebGL 渲染插件
*/
private Boolean enableWebglPlugin;
@Schema(description = "unicode11 插件")
/**
* unicode11 插件
*/
private Boolean enableUnicodePlugin;
@Schema(description = "图片渲染插件")
/**
* 图片渲染插件
*/
private Boolean enableImagePlugin;
}
@@ -146,10 +207,14 @@ public class TerminalPreferenceModel implements PreferenceModel {
@AllArgsConstructor
public static class SessionSettingModel implements IJsonObject {
@Schema(description = "伪终端类型")
/**
* 伪终端类型
*/
private String terminalEmulationType;
@Schema(description = "保存在缓冲区的行数")
/**
* 保存在缓冲区的行数
*/
private Integer scrollBackLine;
}
@@ -160,10 +225,14 @@ public class TerminalPreferenceModel implements PreferenceModel {
@AllArgsConstructor
public static class ShortcutSettingModel implements IJsonObject {
@Schema(description = "是否启用")
/**
* 是否启用
*/
private Boolean enabled;
@Schema(description = "快捷键定义")
/**
* 快捷键定义
*/
private List<ShortcutKeysModel> keys;
}
@@ -174,55 +243,89 @@ public class TerminalPreferenceModel implements PreferenceModel {
@AllArgsConstructor
public static class ActionBarSettingModel implements IJsonObject {
@Schema(description = "命令输入框")
/**
* 命令输入框
*/
private Boolean commandInput;
@Schema(description = "连接状态")
/**
* 连接状态
*/
private Boolean connectStatus;
@Schema(description = "去顶部")
/**
* 去顶部
*/
private Boolean toTop;
@Schema(description = "去底部")
/**
* 去底部
*/
private Boolean toBottom;
@Schema(description = "全选")
/**
* 全选
*/
private Boolean selectAll;
@Schema(description = "搜索")
/**
* 搜索
*/
private Boolean search;
@Schema(description = "复制")
/**
* 复制
*/
private Boolean copy;
@Schema(description = "粘贴")
/**
* 粘贴
*/
private Boolean paste;
@Schema(description = "中断")
/**
* 中断
*/
private Boolean interrupt;
@Schema(description = "回车")
/**
* 回车
*/
private Boolean enter;
@Schema(description = "增大字号")
/**
* 增大字号
*/
private Boolean fontSizePlus;
@Schema(description = "减小字号")
/**
* 减小字号
*/
private Boolean fontSizeSubtract;
@Schema(description = "命令编辑器")
/**
* 命令编辑器
*/
private Boolean commandEditor;
@Schema(description = "打开 SFTP")
/**
* 打开 SFTP
*/
private Boolean openSftp;
@Schema(description = "清空")
/**
* 清空
*/
private Boolean clear;
@Schema(description = "断开连接")
/**
* 断开连接
*/
private Boolean disconnect;
@Schema(description = "关闭终端")
/**
* 关闭终端
*/
private Boolean closeTab;
}
@@ -233,22 +336,34 @@ public class TerminalPreferenceModel implements PreferenceModel {
@AllArgsConstructor
public static class ShortcutKeysModel implements IJsonObject {
@Schema(description = "快捷键操作")
/**
* 快捷键操作
*/
private String item;
@Schema(description = "ctrl 按键")
/**
* ctrl 按键
*/
private Boolean ctrlKey;
@Schema(description = "shift 按键")
/**
* shift 按键
*/
private Boolean shiftKey;
@Schema(description = "alt 按键")
/**
* alt 按键
*/
private Boolean altKey;
@Schema(description = "实际按键")
/**
* 实际按键
*/
private String code;
@Schema(description = "是否启用")
/**
* 是否启用
*/
private Boolean enabled;
}

View File

@@ -1,6 +1,5 @@
package com.orion.visor.module.infra.handler.upload.model;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
@@ -17,13 +16,16 @@ import lombok.NoArgsConstructor;
@Builder
@NoArgsConstructor
@AllArgsConstructor
@Schema(name = "FileUploadRequest", description = "文件上传请求 实体对象")
public class FileUploadRequest {
@Schema(description = "type")
/**
* type
*/
private String type;
@Schema(description = "fileId")
/**
* fileId
*/
private String fileId;
}

View File

@@ -1,6 +1,5 @@
package com.orion.visor.module.infra.handler.upload.model;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
@@ -17,16 +16,21 @@ import lombok.NoArgsConstructor;
@Builder
@NoArgsConstructor
@AllArgsConstructor
@Schema(name = "FileUploadResponse", description = "文件上传响应 实体对象")
public class FileUploadResponse {
@Schema(description = "type")
/**
* type
*/
private String type;
@Schema(description = "fileId")
/**
* fileId
*/
private String fileId;
@Schema(description = "路径")
/**
* 路径
*/
private String path;
}