Ver Fonte

docs 新增工具包注释

AprilWind há 2 anos atrás
pai
commit
e4662ac3ac

+ 21 - 1
ruoyi-common/ruoyi-common-bom/pom.xml

@@ -40,6 +40,7 @@
                 <version>${revision}</version>
             </dependency>
 
+            <!-- 权限认证服务 -->
             <dependency>
                 <groupId>org.dromara</groupId>
                 <artifactId>ruoyi-common-satoken</artifactId>
@@ -88,91 +89,105 @@
                 <version>${revision}</version>
             </dependency>
 
+            <!-- 定时任务 -->
             <dependency>
                 <groupId>org.dromara</groupId>
                 <artifactId>ruoyi-common-job</artifactId>
                 <version>${revision}</version>
             </dependency>
 
+            <!-- RPC服务 -->
             <dependency>
                 <groupId>org.dromara</groupId>
                 <artifactId>ruoyi-common-dubbo</artifactId>
                 <version>${revision}</version>
             </dependency>
 
+            <!-- 分布式事务 -->
             <dependency>
                 <groupId>org.dromara</groupId>
                 <artifactId>ruoyi-common-seata</artifactId>
                 <version>${revision}</version>
             </dependency>
 
+            <!-- 自定义负载均衡 -->
             <dependency>
                 <groupId>org.dromara</groupId>
                 <artifactId>ruoyi-common-loadbalancer</artifactId>
                 <version>${revision}</version>
             </dependency>
 
+            <!-- oss服务 -->
             <dependency>
                 <groupId>org.dromara</groupId>
                 <artifactId>ruoyi-common-oss</artifactId>
                 <version>${revision}</version>
             </dependency>
 
-            <!-- 限流 -->
+            <!-- 限流功能 -->
             <dependency>
                 <groupId>org.dromara</groupId>
                 <artifactId>ruoyi-common-ratelimiter</artifactId>
                 <version>${revision}</version>
             </dependency>
 
+            <!-- 幂等功能 -->
             <dependency>
                 <groupId>org.dromara</groupId>
                 <artifactId>ruoyi-common-idempotent</artifactId>
                 <version>${revision}</version>
             </dependency>
 
+            <!-- 邮件模块 -->
             <dependency>
                 <groupId>org.dromara</groupId>
                 <artifactId>ruoyi-common-mail</artifactId>
                 <version>${revision}</version>
             </dependency>
 
+            <!-- 短信模块 -->
             <dependency>
                 <groupId>org.dromara</groupId>
                 <artifactId>ruoyi-common-sms</artifactId>
                 <version>${revision}</version>
             </dependency>
 
+            <!-- logstash日志推送模块 -->
             <dependency>
                 <groupId>org.dromara</groupId>
                 <artifactId>ruoyi-common-logstash</artifactId>
                 <version>${revision}</version>
             </dependency>
 
+            <!-- ES搜索引擎服务 -->
             <dependency>
                 <groupId>org.dromara</groupId>
                 <artifactId>ruoyi-common-elasticsearch</artifactId>
                 <version>${revision}</version>
             </dependency>
 
+            <!-- 限流模块 -->
             <dependency>
                 <groupId>org.dromara</groupId>
                 <artifactId>ruoyi-common-sentinel</artifactId>
                 <version>${revision}</version>
             </dependency>
 
+            <!-- skywalking日志收集模块 -->
             <dependency>
                 <groupId>org.dromara</groupId>
                 <artifactId>ruoyi-common-skylog</artifactId>
                 <version>${revision}</version>
             </dependency>
 
+            <!-- prometheus监控 -->
             <dependency>
                 <groupId>org.dromara</groupId>
                 <artifactId>ruoyi-common-prometheus</artifactId>
                 <version>${revision}</version>
             </dependency>
 
+            <!-- 通用翻译功能 -->
             <dependency>
                 <groupId>org.dromara</groupId>
                 <artifactId>ruoyi-common-translation</artifactId>
@@ -193,6 +208,7 @@
                 <version>${revision}</version>
             </dependency>
 
+            <!-- 数据加解密模块 -->
             <dependency>
                 <groupId>org.dromara</groupId>
                 <artifactId>ruoyi-common-encrypt</artifactId>
@@ -206,24 +222,28 @@
                 <version>${revision}</version>
             </dependency>
 
+            <!-- websocket模块 -->
             <dependency>
                 <groupId>org.dromara</groupId>
                 <artifactId>ruoyi-common-websocket</artifactId>
                 <version>${revision}</version>
             </dependency>
 
+            <!-- 授权认证 -->
             <dependency>
                 <groupId>org.dromara</groupId>
                 <artifactId>ruoyi-common-social</artifactId>
                 <version>${revision}</version>
             </dependency>
 
+            <!-- 配置中心 -->
             <dependency>
                 <groupId>org.dromara</groupId>
                 <artifactId>ruoyi-common-nacos</artifactId>
                 <version>${revision}</version>
             </dependency>
 
+            <!-- 消息总线模块 -->
             <dependency>
                 <groupId>org.dromara</groupId>
                 <artifactId>ruoyi-common-bus</artifactId>

+ 1 - 1
ruoyi-common/ruoyi-common-bus/pom.xml

@@ -12,7 +12,7 @@
     <artifactId>ruoyi-common-bus</artifactId>
 
     <description>
-        ruoyi-common-bus 模块
+        ruoyi-common-bus 消息总线模块
     </description>
 
     <dependencies>

+ 1 - 1
ruoyi-common/ruoyi-common-dubbo/pom.xml

@@ -12,7 +12,7 @@
     <artifactId>ruoyi-common-dubbo</artifactId>
 
     <description>
-        ruoyi-common-dubbo
+        ruoyi-common-dubbo RPC服务
     </description>
 
     <dependencies>

+ 1 - 1
ruoyi-common/ruoyi-common-nacos/pom.xml

@@ -11,7 +11,7 @@
     <artifactId>ruoyi-common-nacos</artifactId>
 
     <description>
-        ruoyi-common-nacos
+        ruoyi-common-nacos 配置中心
     </description>
 
     <dependencies>

+ 1 - 1
ruoyi-common/ruoyi-common-satoken/pom.xml

@@ -12,7 +12,7 @@
     <artifactId>ruoyi-common-satoken</artifactId>
 
     <description>
-        ruoyi-common-satoken
+        ruoyi-common-satoken 权限认证服务
     </description>
 
     <dependencies>