doc: 调整代码文档注释格式.

2024-10-05 13:27:43 +08:00
parent 3e8b90963b
commit 0cc25559d2
52 changed files with 54 additions and 1 deletions
--- a/src/main/java/com/serliunx/ddns/ManagerLite.java
+++ b/src/main/java/com/serliunx/ddns/ManagerLite.java
@@ -7,6 +7,7 @@ import com.serliunx.ddns.support.SystemInitializer;

 /**
 * 启动类
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/client/IPAddressClient.java
+++ b/src/main/java/com/serliunx/ddns/client/IPAddressClient.java
@@ -11,6 +11,7 @@ import feign.slf4j.Slf4jLogger;

 /**
 * 本机外网IP地址获取
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/client/entity/IPAddressResponse.java
+++ b/src/main/java/com/serliunx/ddns/client/entity/IPAddressResponse.java
@@ -2,6 +2,7 @@ package com.serliunx.ddns.client.entity;

 /**
 * IP地址查询响应
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/config/AbstractConfiguration.java
+++ b/src/main/java/com/serliunx/ddns/config/AbstractConfiguration.java
@@ -11,6 +11,7 @@ import java.util.concurrent.locks.ReentrantLock;

 /**
 * 配置信息的抽象实现, 定义公共逻辑
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/config/Configuration.java
+++ b/src/main/java/com/serliunx/ddns/config/Configuration.java
@@ -7,6 +7,7 @@ import java.util.Map;

 /**
 * 配置信息逻辑定义
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/config/ConfigurationKeys.java
+++ b/src/main/java/com/serliunx/ddns/config/ConfigurationKeys.java
@@ -2,6 +2,7 @@ package com.serliunx.ddns.config;

 /**
 * 配置文件键常量信息
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/config/FileConfiguration.java
+++ b/src/main/java/com/serliunx/ddns/config/FileConfiguration.java
@@ -2,6 +2,7 @@ package com.serliunx.ddns.config;

 /**
 * 文件配置管理
+ *
 * @see PropertiesConfiguration
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
--- a/src/main/java/com/serliunx/ddns/config/PropertiesConfiguration.java
+++ b/src/main/java/com/serliunx/ddns/config/PropertiesConfiguration.java
@@ -10,6 +10,7 @@ import java.util.Set;

 /**
 * 使用{@link Properties}实现的简单读取键值对形式的配置信息实现
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/config/YamlConfiguration.java
+++ b/src/main/java/com/serliunx/ddns/config/YamlConfiguration.java
@@ -9,6 +9,7 @@ import java.util.Map;

 /**
 * yml/yaml格式的配置文件，目前用于语言文件
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/6/17
--- a/src/main/java/com/serliunx/ddns/constant/InstanceClasses.java
+++ b/src/main/java/com/serliunx/ddns/constant/InstanceClasses.java
@@ -9,6 +9,7 @@ import java.util.Map;

 /**
 * 实例类型集合
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/constant/InstanceFileType.java
+++ b/src/main/java/com/serliunx/ddns/constant/InstanceFileType.java
@@ -2,6 +2,7 @@ package com.serliunx.ddns.constant;

 /**
 * 保存实例的文件类型: XML、JSON等
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/constant/InstanceSource.java
+++ b/src/main/java/com/serliunx/ddns/constant/InstanceSource.java
@@ -4,6 +4,7 @@ import static com.serliunx.ddns.constant.SystemConstants.*;

 /**
 * 实例来源
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/constant/InstanceType.java
+++ b/src/main/java/com/serliunx/ddns/constant/InstanceType.java
@@ -2,6 +2,7 @@ package com.serliunx.ddns.constant;

 /**
 * 实例类型: 阿里云、华为云、腾讯云等
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/constant/SystemConstants.java
+++ b/src/main/java/com/serliunx/ddns/constant/SystemConstants.java
@@ -4,6 +4,7 @@ import java.io.File;

 /**
 * 系统常量
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/core/Clearable.java
+++ b/src/main/java/com/serliunx/ddns/core/Clearable.java
@@ -3,6 +3,7 @@ package com.serliunx.ddns.core;
 /**
 * 定义一个实体的清理逻辑
 * <li> 一般用来清理中间加载过程中所产生的无用对象
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/core/InstanceFileFilter.java
+++ b/src/main/java/com/serliunx/ddns/core/InstanceFileFilter.java
@@ -5,6 +5,7 @@ import java.io.FileFilter;

 /**
 * 文件过滤器, 用于加载过滤存储在文件中的实例信息时
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/core/Priority.java
+++ b/src/main/java/com/serliunx/ddns/core/Priority.java
@@ -3,6 +3,7 @@ package com.serliunx.ddns.core;
 /**
 * 定义一个对象的优先级
 * <li> 数字越大, 优先级越小
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/core/Refreshable.java
+++ b/src/main/java/com/serliunx/ddns/core/Refreshable.java
@@ -2,6 +2,7 @@ package com.serliunx.ddns.core;

 /**
 * 刷新逻辑
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/core/context/AbstractInstanceContext.java
+++ b/src/main/java/com/serliunx/ddns/core/context/AbstractInstanceContext.java
@@ -19,6 +19,7 @@ import static com.serliunx.ddns.util.InstanceUtils.validateInstance;

 /**
 * 实例容器的抽象实现, 定义大部分公共逻辑
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/core/context/FileInstanceContext.java
+++ b/src/main/java/com/serliunx/ddns/core/context/FileInstanceContext.java
@@ -7,6 +7,7 @@ import com.serliunx.ddns.core.factory.YamlFileInstanceFactory;

 /**
 * 文件形式的实例容器
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/core/context/GenericInstanceContext.java
+++ b/src/main/java/com/serliunx/ddns/core/context/GenericInstanceContext.java
@@ -2,6 +2,7 @@ package com.serliunx.ddns.core.context;

 /**
 * 简易的容器实现, 需要手动进行刷新、添加实例工厂.
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/25
--- a/src/main/java/com/serliunx/ddns/core/context/InstanceContext.java
+++ b/src/main/java/com/serliunx/ddns/core/context/InstanceContext.java
@@ -4,6 +4,7 @@ import com.serliunx.ddns.core.factory.InstanceFactory;

 /**
 * 实例容器接口定义
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/core/context/MultipleSourceInstanceContext.java
+++ b/src/main/java/com/serliunx/ddns/core/context/MultipleSourceInstanceContext.java
@@ -10,6 +10,7 @@ import java.util.stream.Collectors;

 /**
 * 多数据源的实例容器, 将多种实例来源汇聚到一起
+ *
 * @see InstanceFactory
 * @see InstanceContext
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
--- a/src/main/java/com/serliunx/ddns/core/factory/AbstractInstanceFactory.java
+++ b/src/main/java/com/serliunx/ddns/core/factory/AbstractInstanceFactory.java
@@ -13,6 +13,7 @@ import static com.serliunx.ddns.util.InstanceUtils.validateInstance;

 /**
 * 实例工厂抽象实现, 定义通用逻辑及实例存储.
+ *
 * @see FileInstanceFactory
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
--- a/src/main/java/com/serliunx/ddns/core/factory/InstanceFactory.java
+++ b/src/main/java/com/serliunx/ddns/core/factory/InstanceFactory.java
@@ -8,6 +8,7 @@ import com.serliunx.ddns.core.instance.Instance;
 /**
 * 简单的实例工厂逻辑定义, 添加、获取实例.
 * <li> 属于顶层接口, 定义了通用行为: 如刷新和清理逻辑、排序规则等.
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/core/factory/JacksonFileInstanceFactory.java
+++ b/src/main/java/com/serliunx/ddns/core/factory/JacksonFileInstanceFactory.java
@@ -12,6 +12,7 @@ import static com.serliunx.ddns.constant.InstanceClasses.match;

 /**
 * Jackson文件实例工厂, 使用jackson的ObjectMapper来分别处理json和xml
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/core/factory/JsonFileInstanceFactory.java
+++ b/src/main/java/com/serliunx/ddns/core/factory/JsonFileInstanceFactory.java
@@ -6,6 +6,7 @@ import com.serliunx.ddns.core.instance.Instance;

 /**
 * Jackson-Json文件实例工厂
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/core/factory/ListableInstanceFactory.java
+++ b/src/main/java/com/serliunx/ddns/core/factory/ListableInstanceFactory.java
@@ -8,6 +8,7 @@ import java.util.Set;

 /**
 * 扩展型实自工厂接口, 定义了批量获取、筛选实例的方式.
+ *
 * @see InstanceFactory
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
--- a/src/main/java/com/serliunx/ddns/core/factory/XmlFileInstanceFactory.java
+++ b/src/main/java/com/serliunx/ddns/core/factory/XmlFileInstanceFactory.java
@@ -6,6 +6,7 @@ import com.serliunx.ddns.core.instance.Instance;

 /**
 * Jackson-Xml文件实例工厂
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/core/factory/YamlFileInstanceFactory.java
+++ b/src/main/java/com/serliunx/ddns/core/factory/YamlFileInstanceFactory.java
@@ -21,6 +21,7 @@ import static com.serliunx.ddns.constant.SystemConstants.TYPE_FIELD;

 /**
 * Yaml文件实例工厂, 使用SnakeYaml来反序列化实例. 属于文件型实例工厂.
+ *
 * @see FileInstanceFactory
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
--- a/src/main/java/com/serliunx/ddns/core/instance/AbstractInstance.java
+++ b/src/main/java/com/serliunx/ddns/core/instance/AbstractInstance.java
@@ -14,6 +14,7 @@ import static com.serliunx.ddns.constant.SystemConstants.XML_ROOT_INSTANCE_NAME;

 /**
 * 实例抽象实现
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/core/instance/AliyunInstance.java
+++ b/src/main/java/com/serliunx/ddns/core/instance/AliyunInstance.java
@@ -21,6 +21,7 @@ import static com.serliunx.ddns.constant.SystemConstants.XML_ROOT_INSTANCE_NAME;

 /**
 * 阿里云实例定义
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/core/instance/HuaweiInstance.java
+++ b/src/main/java/com/serliunx/ddns/core/instance/HuaweiInstance.java
@@ -2,6 +2,7 @@ package com.serliunx.ddns.core.instance;

 /**
 * 华为云实例定义
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/core/instance/Instance.java
+++ b/src/main/java/com/serliunx/ddns/core/instance/Instance.java
@@ -6,6 +6,7 @@ import com.serliunx.ddns.core.Refreshable;

 /**
 * 实例行为、参数定义接口
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/core/instance/TencentInstance.java
+++ b/src/main/java/com/serliunx/ddns/core/instance/TencentInstance.java
@@ -2,6 +2,7 @@ package com.serliunx.ddns.core.instance;

 /**
 * 腾讯云实例定义
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/exception/InstanceException.java
+++ b/src/main/java/com/serliunx/ddns/exception/InstanceException.java
@@ -2,6 +2,7 @@ package com.serliunx.ddns.exception;

 /**
 * 实例相关异常信息
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/exception/InstanceExistsException.java
+++ b/src/main/java/com/serliunx/ddns/exception/InstanceExistsException.java
@@ -4,6 +4,7 @@ import com.serliunx.ddns.core.instance.Instance;

 /**
 * 异常信息, 实例已存在
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/support/Assert.java
+++ b/src/main/java/com/serliunx/ddns/support/Assert.java
@@ -4,6 +4,7 @@ import java.util.Collection;

 /**
 * 断言
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
@@ -17,9 +18,10 @@ public final class Assert {
    }

    public static void notNull(Object object, String msg) {
-        if(object == null)
+        if(object == null) {
            throw new NullPointerException(msg);
        }
+    }

    public static void notNull(Object...objects) {
        for (Object object : objects) {
--- a/src/main/java/com/serliunx/ddns/support/ConfigurationContextHolder.java
+++ b/src/main/java/com/serliunx/ddns/support/ConfigurationContextHolder.java
@@ -5,6 +5,7 @@ import com.serliunx.ddns.config.Configuration;
 /**
 * 配置信息上下文
 * <li> {@link Configuration}
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.1
 * @since 2024/7/8
--- a/src/main/java/com/serliunx/ddns/support/Configurer.java
+++ b/src/main/java/com/serliunx/ddns/support/Configurer.java
@@ -5,6 +5,7 @@ import com.serliunx.ddns.core.context.MultipleSourceInstanceContext;

 /**
 * 系统启动配置器
+ *
 * @see SystemInitializer
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
--- a/src/main/java/com/serliunx/ddns/support/InstanceContextHolder.java
+++ b/src/main/java/com/serliunx/ddns/support/InstanceContextHolder.java
@@ -4,6 +4,7 @@ import com.serliunx.ddns.core.instance.Instance;

 /**
 * 实例信息上下文
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/6/15
--- a/src/main/java/com/serliunx/ddns/support/NetworkContextHolder.java
+++ b/src/main/java/com/serliunx/ddns/support/NetworkContextHolder.java
@@ -10,6 +10,7 @@ import java.util.concurrent.locks.ReentrantLock;

 /**
 * 网络参数上下文, 目前仅用于存储本机网络IP
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/support/SystemInitializer.java
+++ b/src/main/java/com/serliunx/ddns/support/SystemInitializer.java
@@ -30,6 +30,7 @@ import static com.serliunx.ddns.config.ConfigurationKeys.KEY_THREAD_POOL_CORE_SI

 /**
 * 系统初始化
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/support/feign/JacksonDecoder.java
+++ b/src/main/java/com/serliunx/ddns/support/feign/JacksonDecoder.java
@@ -14,6 +14,7 @@ import java.util.Collections;

 /**
 * feign解码器
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/support/feign/JacksonEncoder.java
+++ b/src/main/java/com/serliunx/ddns/support/feign/JacksonEncoder.java
@@ -16,6 +16,7 @@ import java.util.Collections;

 /**
 * Feign兼容Jackson(反序列化返回值)
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/support/log/HighlightingCompositeConverter.java
+++ b/src/main/java/com/serliunx/ddns/support/log/HighlightingCompositeConverter.java
@@ -8,6 +8,7 @@ import static ch.qos.logback.core.pattern.color.ANSIConstants.*;

 /**
 * 高亮颜色转换器
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.1
 * @since 2024/6/15
--- a/src/main/java/com/serliunx/ddns/support/log/InstanceNameConverter.java
+++ b/src/main/java/com/serliunx/ddns/support/log/InstanceNameConverter.java
@@ -7,6 +7,7 @@ import com.serliunx.ddns.support.InstanceContextHolder;

 /**
 * 获取当前任何线程的实例信息或者附加信息
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/6/15
--- a/src/main/java/com/serliunx/ddns/support/log/ProcessIdConverter.java
+++ b/src/main/java/com/serliunx/ddns/support/log/ProcessIdConverter.java
@@ -7,6 +7,7 @@ import java.lang.management.ManagementFactory;

 /**
 * 日志变量%pid(进程id) 转换器
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/6/15
--- a/src/main/java/com/serliunx/ddns/thread/TaskThreadFactory.java
+++ b/src/main/java/com/serliunx/ddns/thread/TaskThreadFactory.java
@@ -8,6 +8,7 @@ import java.util.concurrent.atomic.AtomicInteger;

 /**
 * 简易的实例活动相关的线程工厂, 仅仅定义了线程的名称规则.
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/thread/UtilThreadFactory.java
+++ b/src/main/java/com/serliunx/ddns/thread/UtilThreadFactory.java
@@ -2,6 +2,7 @@ package com.serliunx.ddns.thread;

 /**
 * 同 {@link TaskThreadFactory}, 暂未使用.
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/util/InstanceUtils.java
+++ b/src/main/java/com/serliunx/ddns/util/InstanceUtils.java
@@ -5,6 +5,7 @@ import com.serliunx.ddns.support.Assert;

 /**
 * 实例相关工具方法集合
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15
--- a/src/main/java/com/serliunx/ddns/util/ReflectionUtils.java
+++ b/src/main/java/com/serliunx/ddns/util/ReflectionUtils.java
@@ -6,6 +6,7 @@ import java.util.List;

 /**
 * 反射相关工具类
+ *
 * @author <a href="mailto:serliunx@yeah.net">SerLiunx</a>
 * @version 1.0.0
 * @since 2024/5/15