java doc fix

This commit is contained in:
paulch 2024-06-27 09:41:59 +08:00
parent c58ef815f3
commit 87633e2062
13 changed files with 180 additions and 147 deletions

View File

@ -24,5 +24,15 @@
</dependency> </dependency>
</dependencies> </dependencies>
<distributionManagement>
<repository>
<id>bns-releases</id>
<url>http://192.168.0.56:8081/repository/maven-releases/</url>
</repository>
<snapshotRepository>
<id>bns-snapshots</id>
<url>http://192.168.0.56:8081/repository/maven-snapshots/</url>
</snapshotRepository>
</distributionManagement>
</project> </project>

View File

@ -71,4 +71,15 @@
</plugins> </plugins>
</build> </build>
<distributionManagement>
<repository>
<id>bns-releases</id>
<url>http://192.168.0.56:8081/repository/maven-releases/</url>
</repository>
<snapshotRepository>
<id>bns-snapshots</id>
<url>http://192.168.0.56:8081/repository/maven-snapshots/</url>
</snapshotRepository>
</distributionManagement>
</project> </project>

View File

@ -16,8 +16,6 @@ public class GlobalException extends RuntimeException
/** /**
* 错误明细内部调试错误 * 错误明细内部调试错误
*
* {@link CommonResult#getDetailMessage()} 一致的设计
*/ */
private String detailMessage; private String detailMessage;

View File

@ -21,8 +21,6 @@ public final class ServiceException extends RuntimeException
/** /**
* 错误明细内部调试错误 * 错误明细内部调试错误
*
* {@link CommonResult#getDetailMessage()} 一致的设计
*/ */
private String detailMessage; private String detailMessage;

View File

@ -19,9 +19,9 @@ public class StrFormatter
* 此方法只是简单将占位符 {} 按照顺序替换为参数<br> * 此方法只是简单将占位符 {} 按照顺序替换为参数<br>
* 如果想输出 {} 使用 \\转义 { 即可如果想输出 {} 之前的 \ 使用双转义符 \\\\ 即可<br> * 如果想输出 {} 使用 \\转义 { 即可如果想输出 {} 之前的 \ 使用双转义符 \\\\ 即可<br>
* <br> * <br>
* 通常使用format("this is {} for {}", "a", "b") -> this is a for b<br> * 通常使用format("this is {} for {}", "a", "b") - this is a for b<br>
* 转义{} format("this is \\{} for {}", "a", "b") -> this is \{} for a<br> * 转义{} format("this is \\{} for {}", "a", "b") - this is \{} for a<br>
* 转义\ format("this is \\\\{} for {}", "a", "b") -> this is \a for b<br> * 转义\ format("this is \\\\{} for {}", "a", "b") - this is \a for b<br>
* *
* @param strPattern 字符串模板 * @param strPattern 字符串模板
* @param argArray 参数列表 * @param argArray 参数列表

View File

@ -278,7 +278,7 @@ public class ServletUtils
* *
* @param response ServerHttpResponse * @param response ServerHttpResponse
* @param value 响应内容 * @param value 响应内容
* @return Mono<Void> * @return Mono
*/ */
public static Mono<Void> webFluxResponseWriter(ServerHttpResponse response, Object value) public static Mono<Void> webFluxResponseWriter(ServerHttpResponse response, Object value)
{ {
@ -291,7 +291,7 @@ public class ServletUtils
* @param response ServerHttpResponse * @param response ServerHttpResponse
* @param code 响应状态码 * @param code 响应状态码
* @param value 响应内容 * @param value 响应内容
* @return Mono<Void> * @return Mono&lt;Void&gt;
*/ */
public static Mono<Void> webFluxResponseWriter(ServerHttpResponse response, Object value, int code) public static Mono<Void> webFluxResponseWriter(ServerHttpResponse response, Object value, int code)
{ {
@ -305,7 +305,7 @@ public class ServletUtils
* @param status http状态码 * @param status http状态码
* @param code 响应状态码 * @param code 响应状态码
* @param value 响应内容 * @param value 响应内容
* @return Mono<Void> * @return Mono&lt;Void&gt;
*/ */
public static Mono<Void> webFluxResponseWriter(ServerHttpResponse response, HttpStatus status, Object value, int code) public static Mono<Void> webFluxResponseWriter(ServerHttpResponse response, HttpStatus status, Object value, int code)
{ {
@ -320,7 +320,7 @@ public class ServletUtils
* @param status http状态码 * @param status http状态码
* @param code 响应状态码 * @param code 响应状态码
* @param value 响应内容 * @param value 响应内容
* @return Mono<Void> * @return Mono&lt;Void&gt;
*/ */
public static Mono<Void> webFluxResponseWriter(ServerHttpResponse response, String contentType, HttpStatus status, Object value, int code) public static Mono<Void> webFluxResponseWriter(ServerHttpResponse response, String contentType, HttpStatus status, Object value, int code)
{ {

View File

@ -308,13 +308,13 @@ public class StringUtils extends org.apache.commons.lang3.StringUtils
} }
/** /**
* 格式化文本, {} 表示占位符<br> * 格式化文本, {} 表示占位符
* 此方法只是简单将占位符 {} 按照顺序替换为参数<br> * 此方法只是简单将占位符 {} 按照顺序替换为参数
* 如果想输出 {} 使用 \\转义 { 即可如果想输出 {} 之前的 \ 使用双转义符 \\\\ 即可<br> * 如果想输出 {} 使用 \\转义 { 即可如果想输出 {} 之前的 \ 使用双转义符 \\\\ 即可
* <br> *
* 通常使用format("this is {} for {}", "a", "b") -> this is a for b<br> * 通常使用format("this is {} for {}", "a", "b") - this is a for b
* 转义{} format("this is \\{} for {}", "a", "b") -> this is \{} for a<br> * 转义{} format("this is \\{} for {}", "a", "b") - this is \{} for a
* 转义\ format("this is \\\\{} for {}", "a", "b") -> this is \a for b<br> * 转义\ format("this is \\\\{} for {}", "a", "b") - this is \a for b
* *
* @param template 文本模板被替换的部分用 {} 表示 * @param template 文本模板被替换的部分用 {} 表示
* @param params 参数值 * @param params 参数值
@ -438,7 +438,7 @@ public class StringUtils extends org.apache.commons.lang3.StringUtils
} }
/** /**
* 将下划线大写方式命名的字符串转换为驼峰式如果转换前的下划线大写方式命名的字符串为空则返回空字符串 例如HELLO_WORLD->HelloWorld * 将下划线大写方式命名的字符串转换为驼峰式如果转换前的下划线大写方式命名的字符串为空则返回空字符串 例如HELLO_WORLD- HelloWorld
* *
* @param name 转换前的下划线大写方式命名的字符串 * @param name 转换前的下划线大写方式命名的字符串
* @return 转换后的驼峰式命名的字符串 * @return 转换后的驼峰式命名的字符串
@ -475,7 +475,7 @@ public class StringUtils extends org.apache.commons.lang3.StringUtils
/** /**
* 驼峰式命名法 * 驼峰式命名法
* 例如user_name->userName * 例如user_name- userName
*/ */
public static String toCamelCase(String s) public static String toCamelCase(String s)
{ {
@ -542,7 +542,7 @@ public class StringUtils extends org.apache.commons.lang3.StringUtils
* *
* @param pattern 匹配规则 * @param pattern 匹配规则
* @param url 需要匹配的url * @param url 需要匹配的url
* @return * @return 匹配返回true,否则返回false
*/ */
public static boolean isMatch(String pattern, String url) public static boolean isMatch(String pattern, String url)
{ {

View File

@ -38,7 +38,6 @@ public class FileUtils
* *
* @param filePath 文件路径 * @param filePath 文件路径
* @param os 输出流 * @param os 输出流
* @return
*/ */
public static void writeBytes(String filePath, OutputStream os) throws IOException public static void writeBytes(String filePath, OutputStream os) throws IOException
{ {
@ -226,7 +225,6 @@ public class FileUtils
* *
* @param response 响应对象 * @param response 响应对象
* @param realFileName 真实文件名 * @param realFileName 真实文件名
* @return
*/ */
public static void setAttachmentResponseHeader(HttpServletResponse response, String realFileName) throws UnsupportedEncodingException public static void setAttachmentResponseHeader(HttpServletResponse response, String realFileName) throws UnsupportedEncodingException
{ {

View File

@ -181,7 +181,6 @@ public class ExcelUtil<T>
* 隐藏Excel中列属性 * 隐藏Excel中列属性
* *
* @param fields 列属性名 示例[单个"name"/多个"id","name"] * @param fields 列属性名 示例[单个"name"/多个"id","name"]
* @throws Exception
*/ */
public void hideColumn(String... fields) public void hideColumn(String... fields)
{ {
@ -452,7 +451,6 @@ public class ExcelUtil<T>
* @param response 返回数据 * @param response 返回数据
* @param list 导出数据集合 * @param list 导出数据集合
* @param sheetName 工作表的名称 * @param sheetName 工作表的名称
* @return 结果
*/ */
public void exportExcel(HttpServletResponse response, List<T> list, String sheetName) public void exportExcel(HttpServletResponse response, List<T> list, String sheetName)
{ {
@ -466,7 +464,6 @@ public class ExcelUtil<T>
* @param list 导出数据集合 * @param list 导出数据集合
* @param sheetName 工作表的名称 * @param sheetName 工作表的名称
* @param title 标题 * @param title 标题
* @return 结果
*/ */
public void exportExcel(HttpServletResponse response, List<T> list, String sheetName, String title) public void exportExcel(HttpServletResponse response, List<T> list, String sheetName, String title)
{ {
@ -480,7 +477,6 @@ public class ExcelUtil<T>
* 对list数据源将其里面的数据导入到excel表单 * 对list数据源将其里面的数据导入到excel表单
* *
* @param sheetName 工作表的名称 * @param sheetName 工作表的名称
* @return 结果
*/ */
public void importTemplateExcel(HttpServletResponse response, String sheetName) public void importTemplateExcel(HttpServletResponse response, String sheetName)
{ {
@ -492,7 +488,6 @@ public class ExcelUtil<T>
* *
* @param sheetName 工作表的名称 * @param sheetName 工作表的名称
* @param title 标题 * @param title 标题
* @return 结果
*/ */
public void importTemplateExcel(HttpServletResponse response, String sheetName, String title) public void importTemplateExcel(HttpServletResponse response, String sheetName, String title)
{ {
@ -503,9 +498,7 @@ public class ExcelUtil<T>
} }
/** /**
* 对list数据源将其里面的数据导入到excel表单 * 对list数据源将其里面的数据导出到excel表单
*
* @return 结果
*/ */
public void exportExcel(HttpServletResponse response) public void exportExcel(HttpServletResponse response)
{ {

View File

@ -289,7 +289,7 @@ public final class UUID implements java.io.Serializable, Comparable<UUID>
* *
* <p> * <p>
* UUID 的字符串表示形式由此 BNF 描述 * UUID 的字符串表示形式由此 BNF 描述
* * <blockquote>
* <pre> * <pre>
* {@code * {@code
* UUID = <time_low>-<time_mid>-<time_high_and_version>-<variant_and_sequence>-<node> * UUID = <time_low>-<time_mid>-<time_high_and_version>-<variant_and_sequence>-<node>
@ -319,7 +319,7 @@ public final class UUID implements java.io.Serializable, Comparable<UUID>
* *
* <p> * <p>
* UUID 的字符串表示形式由此 BNF 描述 * UUID 的字符串表示形式由此 BNF 描述
* *<blockquote>
* <pre> * <pre>
* {@code * {@code
* UUID = <time_low>-<time_mid>-<time_high_and_version>-<variant_and_sequence>-<node> * UUID = <time_low>-<time_mid>-<time_high_and_version>-<variant_and_sequence>-<node>

View File

@ -2,6 +2,7 @@ package com.bonus.common.core.web.page;
import com.bonus.common.core.text.Convert; import com.bonus.common.core.text.Convert;
import com.bonus.common.core.utils.ServletUtils; import com.bonus.common.core.utils.ServletUtils;
//import org.jetbrains.annotations.NotNull;
/** /**
* 表格数据处理 * 表格数据处理
@ -37,6 +38,7 @@ public class TableSupport
/** /**
* 封装分页对象 * 封装分页对象
* @return 返回 PageDomain 类型的实例
*/ */
public static PageDomain getPageDomain() public static PageDomain getPageDomain()
{ {

View File

@ -36,4 +36,27 @@
<url>http://192.168.0.56:8081/repository/maven-snapshots/</url> <url>http://192.168.0.56:8081/repository/maven-snapshots/</url>
</snapshotRepository> </snapshotRepository>
</distributionManagement> </distributionManagement>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.2.0</version>
<configuration>
<!-- 配置Javadoc生成的特定选项 -->
</configuration>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>javadoc</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project> </project>

46
pom.xml
View File

@ -277,29 +277,29 @@
</pluginManagement> </pluginManagement>
</build> </build>
<repositories> <!-- <repositories>-->
<repository> <!-- <repository>-->
<id>public</id> <!-- <id>public</id>-->
<name>aliyun nexus</name> <!-- <name>aliyun nexus</name>-->
<url>https://maven.aliyun.com/repository/public</url> <!-- <url>https://maven.aliyun.com/repository/public</url>-->
<releases> <!-- <releases>-->
<enabled>true</enabled> <!-- <enabled>true</enabled>-->
</releases> <!-- </releases>-->
</repository> <!-- </repository>-->
</repositories> <!-- </repositories>-->
<pluginRepositories> <!-- <pluginRepositories>-->
<pluginRepository> <!-- <pluginRepository>-->
<id>public</id> <!-- <id>public</id>-->
<name>aliyun nexus</name> <!-- <name>aliyun nexus</name>-->
<url>https://maven.aliyun.com/repository/public</url> <!-- <url>https://maven.aliyun.com/repository/public</url>-->
<releases> <!-- <releases>-->
<enabled>true</enabled> <!-- <enabled>true</enabled>-->
</releases> <!-- </releases>-->
<snapshots> <!-- <snapshots>-->
<enabled>false</enabled> <!-- <enabled>false</enabled>-->
</snapshots> <!-- </snapshots>-->
</pluginRepository> <!-- </pluginRepository>-->
</pluginRepositories> <!-- </pluginRepositories>-->
</project> </project>