docs: 补全 src 全部 Kotlin KDoc 与 Java Javadoc,版本升级至 5.5.1
Gitea Actions Build / Build (push) Canceled after 0s
Gitea Actions Build / Build (push) Canceled after 0s
为所有缺失文档的公开声明补充中文 KDoc/Javadoc(含 exception、json、 springboot、tuple 生成类、MediaType 枚举项及测试),仅插入注释不改代码; gradle.properties VERSIONS 5.4.4 -> 5.5.1。
This commit is contained in:
@@ -22,6 +22,14 @@
|
||||
|
||||
package com.mingliqiye.utils.exception
|
||||
|
||||
/**
|
||||
* 表示编码或解码过程中发生的异常。
|
||||
*
|
||||
* @param message 异常信息,默认为 null
|
||||
* @param throwable 异常原因,默认为 null
|
||||
* @param enableSuppression 是否启用异常抑制,默认为 false
|
||||
* @param writableStackTrace 是否可写入堆栈跟踪信息,默认为 true
|
||||
*/
|
||||
class CodecException @JvmOverloads constructor(
|
||||
message: String? = null,
|
||||
throwable: Throwable? = null,
|
||||
|
||||
@@ -22,6 +22,14 @@
|
||||
|
||||
package com.mingliqiye.utils.exception
|
||||
|
||||
/**
|
||||
* 表示 JSON 内容为空时抛出的异常。
|
||||
*
|
||||
* @param message 异常信息,默认为 null
|
||||
* @param throwable 异常原因,默认为 null
|
||||
* @param enableSuppression 是否启用异常抑制,默认为 false
|
||||
* @param writableStackTrace 是否可写入堆栈跟踪信息,默认为 true
|
||||
*/
|
||||
class EmptyJsonException @JvmOverloads constructor(
|
||||
message: String? = null,
|
||||
throwable: Throwable? = null,
|
||||
|
||||
@@ -22,6 +22,14 @@
|
||||
|
||||
package com.mingliqiye.utils.exception
|
||||
|
||||
/**
|
||||
* 表示 HTTP 相关异常的基类,继承自 [MingLiUtilsBaseException]。
|
||||
*
|
||||
* @param message 异常信息,默认为 null
|
||||
* @param throwable 异常原因,默认为 null
|
||||
* @param enableSuppression 是否启用异常抑制,默认为 false
|
||||
* @param writableStackTrace 是否可写入堆栈跟踪信息,默认为 true
|
||||
*/
|
||||
open class HttpException @JvmOverloads constructor(
|
||||
message: String? = null,
|
||||
throwable: Throwable? = null,
|
||||
|
||||
@@ -22,6 +22,14 @@
|
||||
|
||||
package com.mingliqiye.utils.exception
|
||||
|
||||
/**
|
||||
* 表示 HTTP URL 无效或处理失败时抛出的异常。
|
||||
*
|
||||
* @param message 异常信息,默认为 null
|
||||
* @param throwable 异常原因,默认为 null
|
||||
* @param enableSuppression 是否启用异常抑制,默认为 false
|
||||
* @param writableStackTrace 是否可写入堆栈跟踪信息,默认为 true
|
||||
*/
|
||||
open class HttpUrlException @JvmOverloads constructor(
|
||||
message: String? = null,
|
||||
throwable: Throwable? = null,
|
||||
|
||||
@@ -22,6 +22,14 @@
|
||||
|
||||
package com.mingliqiye.utils.exception
|
||||
|
||||
/**
|
||||
* 表示 JSON 内容无效或不合法时抛出的异常。
|
||||
*
|
||||
* @param message 异常信息,默认为 null
|
||||
* @param throwable 异常原因,默认为 null
|
||||
* @param enableSuppression 是否启用异常抑制,默认为 false
|
||||
* @param writableStackTrace 是否可写入堆栈跟踪信息,默认为 true
|
||||
*/
|
||||
class InvalidJsonException @JvmOverloads constructor(
|
||||
message: String? = null,
|
||||
throwable: Throwable? = null,
|
||||
|
||||
@@ -22,6 +22,14 @@
|
||||
|
||||
package com.mingliqiye.utils.exception
|
||||
|
||||
/**
|
||||
* 表示 JSON 对象类型转换失败时抛出的异常。
|
||||
*
|
||||
* @param message 异常信息,默认为 null
|
||||
* @param throwable 异常原因,默认为 null
|
||||
* @param enableSuppression 是否启用异常抑制,默认为 false
|
||||
* @param writableStackTrace 是否可写入堆栈跟踪信息,默认为 true
|
||||
*/
|
||||
class JsonObjectCastException @JvmOverloads constructor(
|
||||
message: String? = null,
|
||||
throwable: Throwable? = null,
|
||||
|
||||
@@ -22,6 +22,14 @@
|
||||
|
||||
package com.mingliqiye.utils.exception
|
||||
|
||||
/**
|
||||
* 表示 JSON 解析过程中发生的异常。
|
||||
*
|
||||
* @param message 异常信息,默认为 null
|
||||
* @param throwable 异常原因,默认为 null
|
||||
* @param enableSuppression 是否启用异常抑制,默认为 false
|
||||
* @param writableStackTrace 是否可写入堆栈跟踪信息,默认为 true
|
||||
*/
|
||||
class JsonParserException @JvmOverloads constructor(
|
||||
message: String? = null,
|
||||
throwable: Throwable? = null,
|
||||
@@ -30,6 +38,14 @@ class JsonParserException @JvmOverloads constructor(
|
||||
) : JsonException(message, throwable, enableSuppression, writableStackTrace)
|
||||
|
||||
|
||||
/**
|
||||
* 表示 JSON 格式不正确时抛出的异常。
|
||||
*
|
||||
* @param message 异常信息,默认为 null
|
||||
* @param throwable 异常原因,默认为 null
|
||||
* @param enableSuppression 是否启用异常抑制,默认为 false
|
||||
* @param writableStackTrace 是否可写入堆栈跟踪信息,默认为 true
|
||||
*/
|
||||
class JsonFormatException @JvmOverloads constructor(
|
||||
message: String? = null,
|
||||
throwable: Throwable? = null,
|
||||
|
||||
@@ -22,6 +22,14 @@
|
||||
|
||||
package com.mingliqiye.utils.exception
|
||||
|
||||
/**
|
||||
* 表示 JSON 数据类型不匹配时抛出的异常。
|
||||
*
|
||||
* @param message 异常信息,默认为 null
|
||||
* @param throwable 异常原因,默认为 null
|
||||
* @param enableSuppression 是否启用异常抑制,默认为 false
|
||||
* @param writableStackTrace 是否可写入堆栈跟踪信息,默认为 true
|
||||
*/
|
||||
class JsonTypeException @JvmOverloads constructor(
|
||||
message: String? = null,
|
||||
throwable: Throwable? = null,
|
||||
|
||||
@@ -22,6 +22,14 @@
|
||||
|
||||
package com.mingliqiye.utils.exception
|
||||
|
||||
/**
|
||||
* mingli-utils 工具库所有异常的基类,继承自 [RuntimeException]。
|
||||
*
|
||||
* @param message 异常信息,默认为 null
|
||||
* @param cause 异常原因,默认为 null
|
||||
* @param enableSuppression 是否启用异常抑制,默认为 false
|
||||
* @param writableStackTrace 是否可写入堆栈跟踪信息,默认为 true
|
||||
*/
|
||||
open class MingLiUtilsBaseException @JvmOverloads constructor(
|
||||
message: String? = null,
|
||||
cause: Throwable? = null,
|
||||
|
||||
@@ -22,6 +22,14 @@
|
||||
|
||||
package com.mingliqiye.utils.exception
|
||||
|
||||
/**
|
||||
* 表示请求的资源未找到时抛出的异常。
|
||||
*
|
||||
* @param message 异常信息,默认为 null
|
||||
* @param throwable 异常原因,默认为 null
|
||||
* @param enableSuppression 是否启用异常抑制,默认为 false
|
||||
* @param writableStackTrace 是否可写入堆栈跟踪信息,默认为 true
|
||||
*/
|
||||
class NotFoundResourceException @JvmOverloads constructor(
|
||||
message: String? = null,
|
||||
throwable: Throwable? = null,
|
||||
|
||||
Reference in New Issue
Block a user