translate class description to english (#1641)

Signed-off-by: 东风 <[email protected]> Co-authored-by: 东风 <[email protected]>
apache · Mar 13, 2024 · b3f2067 · b3f2067
1 parent d66de21
commit b3f2067
Show file tree

Hide file tree

Showing 45 changed files with 129 additions and 85 deletions.
diff --git a/...ger/src/main/java/org/dromara/hertzbeat/manager/component/alerter/AlertNotifyHandler.java b/...ger/src/main/java/org/dromara/hertzbeat/manager/component/alerter/AlertNotifyHandler.java
@@ -23,7 +23,7 @@
 import org.dromara.hertzbeat.manager.support.exception.AlertNoticeException;
 
 /**
- *
+ * AlertNotifyHandler interface
  */
 public interface AlertNotifyHandler {
 

diff --git a/manager/src/main/java/org/dromara/hertzbeat/manager/component/alerter/AlertStoreHandler.java b/manager/src/main/java/org/dromara/hertzbeat/manager/component/alerter/AlertStoreHandler.java
@@ -21,15 +21,17 @@
 
 /**
  * 报警持久化
- *
+ * Alarm persistence
  *
  */
 public interface AlertStoreHandler {
 
     /**
      * 持久化报警记录
      * 需在持久化的同时对alert的标签信息tags关联赋值
-     *
+     * Persistent alarm records
+     * It is necessary to associate and assign values
+     * to the alert tag information tags while persisting.
      * @param alert 报警
      */
     void store(Alert alert);

diff --git a/...rg/dromara/hertzbeat/manager/component/alerter/impl/DiscordBotAlertNotifyHandlerImpl.java b/...rg/dromara/hertzbeat/manager/component/alerter/impl/DiscordBotAlertNotifyHandlerImpl.java
@@ -35,7 +35,7 @@
 import java.util.List;
 
 /**
- *
+ * Send alarm information through Discord robot
  * Created by gcdd1993 on 2023/1/19
  */
 @Component

diff --git a/...ava/org/dromara/hertzbeat/manager/component/alerter/impl/EmailAlertNotifyHandlerImpl.java b/...ava/org/dromara/hertzbeat/manager/component/alerter/impl/EmailAlertNotifyHandlerImpl.java
@@ -44,7 +44,7 @@
 import java.util.ResourceBundle;
 
 /**
- *
+ * Send alarm information through email
  */
 @Component
 @RequiredArgsConstructor

diff --git a/...romara/hertzbeat/manager/component/alerter/impl/HuaweiCloudSmnAlertNotifyHandlerImpl.java b/...romara/hertzbeat/manager/component/alerter/impl/HuaweiCloudSmnAlertNotifyHandlerImpl.java
@@ -36,7 +36,7 @@
 import java.util.concurrent.ConcurrentHashMap;
 
 /**
- *
+ * Send alarm information through Huawei CloudSmn
  */
 @Component
 @RequiredArgsConstructor

diff --git a/...rg/dromara/hertzbeat/manager/component/alerter/impl/ServerChanAlertNotifyHandlerImpl.java b/...rg/dromara/hertzbeat/manager/component/alerter/impl/ServerChanAlertNotifyHandlerImpl.java
@@ -30,7 +30,7 @@
 /**
  * Server酱发送
  *
- *
+ * Send alarm information through Server
  */
 @Component
 @RequiredArgsConstructor

diff --git a/.../java/org/dromara/hertzbeat/manager/component/alerter/impl/SmsAlertNotifyHandlerImpl.java b/.../java/org/dromara/hertzbeat/manager/component/alerter/impl/SmsAlertNotifyHandlerImpl.java
@@ -32,7 +32,7 @@
 import java.util.ResourceBundle;
 
 /**
- *
+ * Send alarm information through Sms
  */
 @Component
 @RequiredArgsConstructor

diff --git a/...va/org/dromara/hertzbeat/manager/component/alerter/impl/WeChatAlertNotifyHandlerImpl.java b/...va/org/dromara/hertzbeat/manager/component/alerter/impl/WeChatAlertNotifyHandlerImpl.java
@@ -30,7 +30,7 @@
 import com.google.gson.JsonParser;
 
 /**
- *
+ * Send alarm information through WeChat
  */
 final class WeChatAlertNotifyHandlerImpl extends AbstractAlertNotifyHandlerImpl {
     private static final Logger log = LoggerFactory.getLogger(WeChatAlertNotifyHandlerImpl.class);

diff --git a/...a/org/dromara/hertzbeat/manager/component/alerter/impl/WebHookAlertNotifyHandlerImpl.java b/...a/org/dromara/hertzbeat/manager/component/alerter/impl/WebHookAlertNotifyHandlerImpl.java
@@ -34,7 +34,7 @@
 import java.util.Map;
 
 /**
- *
+ * Send alarm information through WebHookAlter
  */
 @Component
 @Slf4j

diff --git a/manager/src/main/java/org/dromara/hertzbeat/manager/config/SecurityCorsConfiguration.java b/manager/src/main/java/org/dromara/hertzbeat/manager/config/SecurityCorsConfiguration.java
@@ -28,7 +28,7 @@
 
 /**
  *
- *
+ * SecurityCorsConfiguration class
  */
 @Configuration
 public class SecurityCorsConfiguration {

diff --git a/manager/src/main/java/org/dromara/hertzbeat/manager/config/SystemCommandLineRunner.java b/manager/src/main/java/org/dromara/hertzbeat/manager/config/SystemCommandLineRunner.java
@@ -31,7 +31,7 @@
 import java.util.TimeZone;
 
 /**
- *
+ * SystemCommandLineRunner class
  * @since 4/7/2023
  */
 @Component

diff --git a/manager/src/main/java/org/dromara/hertzbeat/manager/dao/GeneralConfigDao.java b/manager/src/main/java/org/dromara/hertzbeat/manager/dao/GeneralConfigDao.java
@@ -23,20 +23,21 @@
 import org.springframework.stereotype.Component;
 
 /**
- * 公共服务端配置Dao
+ * Public server configuration Dao
  * todo common config data cache
  * <p>该接口继承了JpaRepository和JpaSpecificationExecutor两个接口，提供基本的CRUD操作和规范查询能力。</p>
- *
+ * <p>This interface inherits the two interfaces JpaRepository and JpaSpecificationExecutor, providing basic CRUD operations and specification query capabilities.</p>
  *
  */
 @Component
 public interface GeneralConfigDao extends JpaRepository<GeneralConfig, Long>, JpaSpecificationExecutor<GeneralConfig> {
 
     /**
      * 通过类型查询
+     * Query by type
      *
      * @param type 类型
-     * @return 返回查询到的配置信息
+     * @return 返回查询到的配置信息 Return the queried configuration information
      */
     GeneralConfig findByType(String type);
 }
diff --git a/manager/src/main/java/org/dromara/hertzbeat/manager/dao/NoticeRuleDao.java b/manager/src/main/java/org/dromara/hertzbeat/manager/dao/NoticeRuleDao.java
@@ -25,14 +25,15 @@
 
 /**
  * NoticeRule数据库操作
- *
+ * NoticeRule database operations
  *
  */
 public interface NoticeRuleDao extends JpaRepository<NoticeRule, Long>, JpaSpecificationExecutor<NoticeRule> {
 
     /**
      * 查询所有已启用的通知策略
-     * @return 通知策略
+     * Query all enabled notification policies
+     * @return notification policies
      */
     List<NoticeRule> findNoticeRulesByEnableTrue();
 }
diff --git a/manager/src/main/java/org/dromara/hertzbeat/manager/dao/NoticeTemplateDao.java b/manager/src/main/java/org/dromara/hertzbeat/manager/dao/NoticeTemplateDao.java
@@ -23,7 +23,7 @@
 
 /**
  * NoticeTemplate数据库操作
- *
+ * Query all enabled notification policies
  *
  */
 public interface NoticeTemplateDao extends JpaRepository<NoticeTemplate, Long>, JpaSpecificationExecutor<NoticeTemplate> {

diff --git a/manager/src/main/java/org/dromara/hertzbeat/manager/dao/ParamDao.java b/manager/src/main/java/org/dromara/hertzbeat/manager/dao/ParamDao.java
@@ -25,7 +25,7 @@
 
 /**
  * ParamDao 数据库操作
- *
+ * ParamDao database operations
  *
  *
  */

diff --git a/manager/src/main/java/org/dromara/hertzbeat/manager/pojo/dto/AppCount.java b/manager/src/main/java/org/dromara/hertzbeat/manager/pojo/dto/AppCount.java
@@ -22,7 +22,7 @@
 import lombok.NoArgsConstructor;
 
 /**
- *
+ * AppCount class
  *
  */
 @AllArgsConstructor

diff --git a/manager/src/main/java/org/dromara/hertzbeat/manager/pojo/dto/Dashboard.java b/manager/src/main/java/org/dromara/hertzbeat/manager/pojo/dto/Dashboard.java
@@ -26,7 +26,7 @@
 
 /**
  * 大屏仪表盘统计信息
- *
+ * Large screen dashboard statistics
  *
  */
 @Data

diff --git a/manager/src/main/java/org/dromara/hertzbeat/manager/pojo/dto/EmailNoticeSender.java b/manager/src/main/java/org/dromara/hertzbeat/manager/pojo/dto/EmailNoticeSender.java
@@ -26,7 +26,7 @@
 
 /**
  * 邮件账号配置dto
- *
+ * Email account configuration dto
  *
  */
 @Data

diff --git a/manager/src/main/java/org/dromara/hertzbeat/manager/pojo/dto/FileDTO.java b/manager/src/main/java/org/dromara/hertzbeat/manager/pojo/dto/FileDTO.java
@@ -26,7 +26,7 @@
 
 /**
  * 文件存储
- *
+ * File storage
  *
  * Created by gcdd1993 on 2023/9/13
  */

diff --git a/manager/src/main/java/org/dromara/hertzbeat/manager/pojo/dto/ObjectStoreDTO.java b/manager/src/main/java/org/dromara/hertzbeat/manager/pojo/dto/ObjectStoreDTO.java
@@ -24,7 +24,7 @@
 
 /**
  * 文件存储容器
- *
+ * file storage container
  *
  * Created by gcdd1993 on 2023/9/13
  */

diff --git a/manager/src/main/java/org/dromara/hertzbeat/manager/pojo/dto/ParamDefineDto.java b/manager/src/main/java/org/dromara/hertzbeat/manager/pojo/dto/ParamDefineDto.java
@@ -26,7 +26,7 @@
 
 /**
  * 参数定义传输实体
- *
+ * Parameters define transfer entities
  *
  */
 @Data

diff --git a/manager/src/main/java/org/dromara/hertzbeat/manager/pojo/dto/SystemConfig.java b/manager/src/main/java/org/dromara/hertzbeat/manager/pojo/dto/SystemConfig.java
@@ -24,7 +24,7 @@
 
 /**
  * 系统配置
- *
+ * System Configuration
  *
  * @since 4/7/2023
  */

diff --git a/manager/src/main/java/org/dromara/hertzbeat/manager/scheduler/AssignJobs.java b/manager/src/main/java/org/dromara/hertzbeat/manager/scheduler/AssignJobs.java
@@ -25,7 +25,7 @@
 
 /**
  * 分配的采集任务列表
- *
+ * List of assigned collection tasks
  */
 @Slf4j
 @Data

diff --git a/manager/src/main/java/org/dromara/hertzbeat/manager/scheduler/ConsistentHash.java b/manager/src/main/java/org/dromara/hertzbeat/manager/scheduler/ConsistentHash.java
@@ -28,6 +28,7 @@
 
 /**
  * 一致性hash实现的采集器与任务映射调度
+ *  Collector and task mapping scheduling implemented by consistent hashing
  *
  */
 @Slf4j

diff --git a/manager/src/main/java/org/dromara/hertzbeat/manager/service/MonitorService.java b/manager/src/main/java/org/dromara/hertzbeat/manager/service/MonitorService.java
@@ -35,7 +35,7 @@
 
 /**
  * 监控管理服务
- *
+ * Monitoring and management services
  *
  */
 public interface MonitorService {

diff --git a/manager/src/main/java/org/dromara/hertzbeat/manager/service/NoticeDispatchService.java b/manager/src/main/java/org/dromara/hertzbeat/manager/service/NoticeDispatchService.java
@@ -19,7 +19,7 @@
 
 /**
  * 消息通知转发接口
- *
+ * Message notification forwarding interface
  *
  */
 public interface NoticeDispatchService {

diff --git a/manager/src/main/java/org/dromara/hertzbeat/manager/service/ObjectStoreService.java b/manager/src/main/java/org/dromara/hertzbeat/manager/service/ObjectStoreService.java
@@ -25,7 +25,7 @@
 
 /**
  * 文件存储服务
- *
+ * File storage service
  *
  * Created by gcdd1993 on 2023/9/13
  */

diff --git a/manager/src/main/java/org/dromara/hertzbeat/manager/service/TagService.java b/manager/src/main/java/org/dromara/hertzbeat/manager/service/TagService.java
@@ -29,7 +29,7 @@
 
 /**
  * 标签服务
- *
+ * tag service
  *
  */
 public interface TagService {

diff --git a/...src/main/java/org/dromara/hertzbeat/manager/service/impl/AbstractImExportServiceImpl.java b/...src/main/java/org/dromara/hertzbeat/manager/service/impl/AbstractImExportServiceImpl.java
@@ -43,7 +43,7 @@
 import java.util.Collections;
 
 /**
- *
+ * class AbstractImExportServiceImpl
  * Created by gcdd1993 on 2023/3/31
  */
 @Slf4j

diff --git a/manager/src/main/java/org/dromara/hertzbeat/manager/service/impl/MonitorServiceImpl.java b/manager/src/main/java/org/dromara/hertzbeat/manager/service/impl/MonitorServiceImpl.java
@@ -71,7 +71,7 @@
 
 /**
  * 监控管理服务实现
- *
+ * Monitoring and management service implementation
  *
  */
 @Service

diff --git a/...ger/src/main/java/org/dromara/hertzbeat/manager/service/impl/NoticeConfigServiceImpl.java b/...ger/src/main/java/org/dromara/hertzbeat/manager/service/impl/NoticeConfigServiceImpl.java
@@ -51,7 +51,7 @@
 
 /**
  * 消息通知配置实现
- *
+ * Message notification configuration implementation
  *
  */
 @Service

diff --git a/...rc/main/java/org/dromara/hertzbeat/manager/service/impl/ObjectStoreConfigServiceImpl.java b/...rc/main/java/org/dromara/hertzbeat/manager/service/impl/ObjectStoreConfigServiceImpl.java
@@ -38,7 +38,7 @@
 
 /**
  * 文件存储配置服务
- *
+ * File storage configuration service
  *
  * Created by gcdd1993 on 2023/9/13
  */

diff --git a/...r/src/main/java/org/dromara/hertzbeat/manager/service/impl/ObsObjectStoreServiceImpl.java b/...r/src/main/java/org/dromara/hertzbeat/manager/service/impl/ObsObjectStoreServiceImpl.java
@@ -32,7 +32,7 @@
 
 /**
  * 华为云存储服务
- *
+ * Huawei cloud storage service
  *
  * Created by gcdd1993 on 2023/9/13
  */

diff --git a/...c/main/java/org/dromara/hertzbeat/manager/support/exception/MonitorDatabaseException.java b/...c/main/java/org/dromara/hertzbeat/manager/support/exception/MonitorDatabaseException.java
@@ -19,7 +19,7 @@
 
 /**
  * 数据库操作异常
- *
+ * Database operation exception
  *
  */
 public class MonitorDatabaseException extends RuntimeException {

diff --git a/...src/main/java/org/dromara/hertzbeat/manager/support/exception/MonitorDetectException.java b/...src/main/java/org/dromara/hertzbeat/manager/support/exception/MonitorDetectException.java
@@ -19,7 +19,7 @@
 
 /**
  * 探测失败异常
- *
+ * Detection failure exception
  *
  */
 public class MonitorDetectException extends RuntimeException {

diff --git a/...rc/main/java/org/dromara/hertzbeat/manager/support/exception/MonitorMetricsException.java b/...rc/main/java/org/dromara/hertzbeat/manager/support/exception/MonitorMetricsException.java
@@ -19,7 +19,7 @@
 
 /**
  * 描述：监控指标异常
- *
+ * Description: Abnormal monitoring indicators
  */
 public class MonitorMetricsException extends RuntimeException {
     public MonitorMetricsException(String message) {

diff --git a/warehouse/src/main/java/org/dromara/hertzbeat/warehouse/WarehouseWorkerPool.java b/warehouse/src/main/java/org/dromara/hertzbeat/warehouse/WarehouseWorkerPool.java
@@ -28,8 +28,8 @@
 import java.util.concurrent.TimeUnit;
 
 /**
- * warehouse Worker thread pool
- *
+ * warehouse 工作线程池
+ * warehouse worker thread pool
  *
  */
 @Component

diff --git a/...ouse/src/main/java/org/dromara/hertzbeat/warehouse/config/WarehouseAutoConfiguration.java b/...ouse/src/main/java/org/dromara/hertzbeat/warehouse/config/WarehouseAutoConfiguration.java
@@ -21,7 +21,7 @@
 import org.springframework.context.annotation.ComponentScan;
 
 /**
- * Warehouse Auto Configuration
+ * WarehouseAutoConfiguration class
  * @version 2.1
  * Created by Musk.Chen on 2023/1/14
  */
-Original file line number
+Diff line change
@@ Expand Up / @@ -23,7 +23,7 @@ @@
     import org.dromara.hertzbeat.manager.support.exception.AlertNoticeException;
     /**
-     *
+     * AlertNotifyHandler interface
      */
     public interface AlertNotifyHandler {
@@ Expand Down @@