Skip to content

Commit 37c4b78

Browse files
committed
javadoc 调整
1 parent f68d7ec commit 37c4b78

File tree

7 files changed

+13
-8
lines changed

7 files changed

+13
-8
lines changed

api-boot-project/api-boot-autoconfigure/src/main/java/org/minbox/framework/api/boot/autoconfigure/ratelimiter/ApiBootRateLimiterAutoConfiguration.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ public ApiBootRateLimiterAutoConfiguration(ApiBootRateLimiterProperties apiBootR
6363
/**
6464
* ApiBoot Rate Limiter Interceptor
6565
*
66+
* @param apiBootRateLimiter ApiBoot RateLimiter
6667
* @return ApiBootDefaultRateLimiterInterceptorHandler
6768
*/
6869
@Bean
@@ -74,6 +75,7 @@ public ApiBootDefaultRateLimiterInterceptorHandler apiBootDefaultRateLimiterInte
7475
/**
7576
* google guava rate limiter
7677
*
78+
* @param rateLimiterConfigCentre RateLimiter Config Centre
7779
* @return ApiBootRateLimiter
7880
*/
7981
@Bean
@@ -98,6 +100,7 @@ public RateLimiterConfigCentre defaultRateLimiterConfigCentre() {
98100
/**
99101
* ApiBoot Rate Limiter Configuration
100102
*
103+
* @param apiBootDefaultRateLimiterInterceptorHandler ApiBoot RateLimiter Interceptor
101104
* @return ApiBootRateLimiterConfiguration
102105
*/
103106
@Bean

api-boot-project/api-boot-autoconfigure/src/main/java/org/minbox/framework/api/boot/autoconfigure/ratelimiter/ApiBootRateLimiterNacosConfigConfiguration.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ public ApiBootRateLimiterNacosConfigConfiguration(NacosConfigProperties nacosCon
7676
/**
7777
* Initialize Nacos Configuration Center
7878
*
79+
* @param configService Nacos Config Service
7980
* @return RateLimiterConfigCentre
8081
* @see NacosRateLimiterConfigCentre
8182
*/

api-boot-project/api-boot-autoconfigure/src/main/java/org/minbox/framework/api/boot/autoconfigure/ratelimiter/ApiBootRateLimiterRedisAutoConfiguration.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,8 @@ public ApiBootRateLimiterRedisAutoConfiguration(ApiBootRateLimiterProperties api
5757
/**
5858
* redis lua rate limiter
5959
*
60-
* @param redisTemplate redis template
60+
* @param redisTemplate redis template
61+
* @param rateLimiterConfigCentre RateLimiter Config Centre
6162
* @return ApiBootRateLimiter
6263
*/
6364
@Bean

api-boot-project/api-boot-plugins/api-boot-plugin-rate-limiter/src/main/java/org/minbox/framework/api/boot/plugin/rate/limiter/centre/support/NacosRateLimiterConfigCentre.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -75,12 +75,12 @@ public NacosRateLimiterConfigCentre(ConfigService configService) {
7575
/**
7676
* get QPS config from nacos
7777
* for example properties:
78-
* 1. /user/list -> .user.list: 5
79-
* 2. /user/detail -> .user.detail: 10
78+
* 1. /user/list = .user.list: 5
79+
* 2. /user/detail = .user.detail: 10
8080
*
8181
* @param configKey config key
8282
* @return qps
83-
* @throws ApiBootException
83+
* @throws ApiBootException ApiBoot Exception
8484
*/
8585
@Override
8686
public Long getQps(String configKey) throws ApiBootException {
@@ -101,7 +101,7 @@ public Long getQps(String configKey) throws ApiBootException {
101101
*
102102
* @param configKey config key
103103
* @param QPS QPS value
104-
* @throws ApiBootException
104+
* @throws ApiBootException ApiBoot Exception
105105
*/
106106
@Override
107107
public void setQps(String configKey, Long QPS) throws ApiBootException {

api-boot-project/api-boot-plugins/api-boot-plugin-rate-limiter/src/main/java/org/minbox/framework/api/boot/plugin/rate/limiter/support/AbstractRateLimiter.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ public AbstractRateLimiter(Long globalQPS, RateLimiterConfigCentre rateLimiterCo
5757
* third:GlobalQPS from application.yml(api.boot.rate-limiter.global-qps)
5858
*
5959
* @param configKey config key
60-
* @param annotationQPS @RateLimiter(QPS=xx)
60+
* @param annotationQPS RateLimiter(QPS=xx)
6161
* @return QPS value
6262
*/
6363
protected Long getPriorityQPS(String configKey, Double annotationQPS) {

api-boot-project/api-boot-plugins/api-boot-plugin-rate-limiter/src/main/java/org/minbox/framework/api/boot/plugin/rate/limiter/support/GoogleGuavaRateLimiter.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public GoogleGuavaRateLimiter(Long globalQPS, RateLimiterConfigCentre rateLimite
3939
/**
4040
* google guava away
4141
*
42-
* @param annotationQPS @RateLimiter QPS value
42+
* @param annotationQPS RateLimiter QPS value
4343
* @param requestUri request uri
4444
* @return true : allow access to
4545
*/

api-boot-project/api-boot-plugins/api-boot-plugin-rate-limiter/src/main/java/org/minbox/framework/api/boot/plugin/rate/limiter/support/RedisLuaRateLimiter.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ public RedisLuaRateLimiter(Long globalQPS, RateLimiterConfigCentre rateLimiterCo
7777
* Processing traffic restrictions using LUA scripts
7878
* Processing with Spring Cloud Gateway official script
7979
*
80-
* @param annotationQPS @RateLimiter QPS value
80+
* @param annotationQPS RateLimiter QPS value
8181
* @param requestUri request uri
8282
* @return true : allow access to
8383
*/

0 commit comments

Comments
 (0)