pref: 完善注释

This commit is contained in:
xiaozzzi 2024-04-08 01:15:36 +08:00
parent da5e74e915
commit 9e561358eb
5 changed files with 23 additions and 6 deletions

View File

@ -185,7 +185,7 @@ public class ArticleController {
}
/**
* 为文章快速增加/删除标签
* 快速增加/删除标签
*
* @since 1.10.0
*/

View File

@ -61,7 +61,6 @@ public class DocController {
/**
* 修改排序
* <p/>todo 返回列表, 兼容列表查询条件
*
* @param tree 需要修改排序的文档列表
* @return 文档列表

View File

@ -3,6 +3,9 @@ package com.blossom.backend.server.doc.pojo;
import com.blossom.backend.server.doc.DocTypeEnum;
import lombok.Data;
import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import java.util.List;
/**
@ -18,16 +21,25 @@ public class DocTreeUpdSortReq {
*/
private List<Doc> docs;
/**
* 类型 1:文章文件夹; 2:图片文件夹
* 件夹类型 1:文章文件夹; 2:图片文件夹
*
* @see com.blossom.backend.server.folder.FolderTypeEnum
*/
@NotNull(message = "文件夹类型为必填项")
@Min(value = 1, message = "文件夹类型错误")
@Max(value = 2, message = "文件夹类型错误")
private Integer folderType;
/**
* [Picture + Article] 只查询图片文件夹, 以及含有图片的文章文件夹
*/
@NotNull(message = "文件夹类型为必填项")
private Boolean onlyPicture;
/**
* 获取查询的文件夹类型
*
* @return 返回结果不会为 null
*/
public Boolean getOnlyPicture() {
if (onlyPicture == null) {
return false;

View File

@ -52,7 +52,7 @@ public class FolderController {
/**
* 查询专题列表
*
* @param starStatus 公开状态,
* @param starStatus 公开状态
*/
@GetMapping("/subjects")
public R<List<FolderSubjectRes>> listSubject(@RequestParam("starStatus") Integer starStatus) {
@ -143,7 +143,7 @@ public class FolderController {
}
/**
* 为文件夹快速增加/删除标签
* 快速增加/删除标签
*
* @since 1.10.0
*/

View File

@ -1 +1,7 @@
客户端静态文件放置位置。
在 blossom-editor 工程下执行如下语句, 打包成网页后复制到后台 static/editor 资源目录下
```
npm run build
```