Add hyperlinks to some notes (#1463)

* Add hyperlinks to some notes * remove unused import class * fixes the @see error * fixes the @see error * fixes javadoc line is longer than 200 characters * fixes javadoc line is longer than 200 characters * fixes javadoc line is longer than 200 characters * Add hyperlinks to some notes * fix checkstyle * fix checkstyle Co-authored-by: dengliming <liming.d.pro@gmail.com>
apache · May 14, 2021 · b5891ac · b5891ac
1 parent f382faf
commit b5891ac
Show file tree

Hide file tree

Showing 9 changed files with 19 additions and 14 deletions.
diff --git a/script/shenyu_checkstyle.xml b/script/shenyu_checkstyle.xml
@@ -67,6 +67,7 @@
         <module name="MethodLength"/>
         <module name="LineLength">
             <property name="max" value="200"/>
+            <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
         </module>
         <module name="OuterTypeNumber"/>
 

diff --git a/shenyu-admin/src/main/java/org/apache/shenyu/admin/exception/ExceptionHandlers.java b/shenyu-admin/src/main/java/org/apache/shenyu/admin/exception/ExceptionHandlers.java
@@ -30,7 +30,8 @@
 
 /**
  * ControllerMethodResolver.
- * https://dzone.com/articles/global-exception-handling-with-controlleradvice.
+ *
+ * @see <a href="https://dzone.com/articles/global-exception-handling-with-controlleradvice">global-exception-handling-with-controlleradvice</a>
  */
 @Slf4j
 @ControllerAdvice

diff --git a/...n/java/org/apache/shenyu/plugin/ratelimiter/algorithm/ConcurrentRateLimiterAlgorithm.java b/...n/java/org/apache/shenyu/plugin/ratelimiter/algorithm/ConcurrentRateLimiterAlgorithm.java
@@ -28,10 +28,10 @@
 import java.util.List;
 
 /**
- * See https://stripe.com/blog/rate-limiters and
- * https://gist.github.com/ptarjan/e38f45f2dfe601419ca3af937fff574d#file-1-check_request_rate_limiter-rb-L11-L34
  * The type Concurrent rate limiter algorithm.
- * 
+ *
+ * @see <a href="https://stripe.com/blog/rate-limiters">rate-limiters</a>
+ * @see <a href="https://gist.github.com/ptarjan/e38f45f2dfe601419ca3af937fff574d#file-1-check_request_rate_limiter-rb-L11-L34">check_request_rate_limiter</a>
  */
 @Join
 public class ConcurrentRateLimiterAlgorithm extends AbstractRateLimiterAlgorithm {
@@ -40,7 +40,7 @@ public class ConcurrentRateLimiterAlgorithm extends AbstractRateLimiterAlgorithm
     protected String getScriptName() {
         return RateLimitEnum.CONCURRENT.getScriptName();
     }
-    
+
     @Override
     protected String getKeyName() {
         return RateLimitEnum.CONCURRENT.getKeyName();
@@ -52,7 +52,7 @@ public List<String> getKeys(final String id) {
         String requestKey = UUIDUtils.getInstance().generateShortUuid();
         return Arrays.asList(tokenKey, requestKey);
     }
-    
+
     @Override
     @SuppressWarnings("unchecked")
     public void callback(final RedisScript<?> script, final List<String> keys, final List<String> scriptArgs) {

diff --git a/.../java/org/apache/shenyu/plugin/ratelimiter/algorithm/TokenBucketRateLimiterAlgorithm.java b/.../java/org/apache/shenyu/plugin/ratelimiter/algorithm/TokenBucketRateLimiterAlgorithm.java
@@ -22,9 +22,9 @@
 
 /**
  * The type Token bucket rate limiter algorithm.
- * See https://stripe.com/blog/rate-limiters and
- * https://gist.github.com/ptarjan/e38f45f2dfe601419ca3af937fff574d#file-1-check_request_rate_limiter-rb-L11-L34
- * 
+ *
+ * @see <a href="https://stripe.com/blog/rate-limiters">rate-limiters</a>
+ * @see <a href="https://gist.github.com/ptarjan/e38f45f2dfe601419ca3af937fff574d#file-1-check_request_rate_limiter-rb-L11-L34">check_request_rate_limiter</a>
  */
 @Join
 public class TokenBucketRateLimiterAlgorithm extends AbstractRateLimiterAlgorithm {

diff --git a/shenyu-spi/src/main/java/org/apache/shenyu/spi/ExtensionLoader.java b/shenyu-spi/src/main/java/org/apache/shenyu/spi/ExtensionLoader.java
@@ -31,7 +31,8 @@
 /**
  * The type Extension loader.
  * This is done by loading the properties file.
- * https://github.com/apache/dubbo/blob/master/dubbo-common/src/main/java/org/apache/dubbo/common/extension/ExtensionLoader.java
+ *
+ * @see <a href="https://github.com/apache/dubbo/blob/master/dubbo-common/src/main/java/org/apache/dubbo/common/extension/ExtensionLoader.java">ExtensionLoader</a>
  */
 @Slf4j
 @SuppressWarnings("all")

diff --git a/shenyu-spi/src/main/java/org/apache/shenyu/spi/SPI.java b/shenyu-spi/src/main/java/org/apache/shenyu/spi/SPI.java
@@ -26,7 +26,7 @@
 /**
  * SPI Extend the processing.
  * All spi system reference the apache implementation of
- * https://github.com/apache/dubbo/blob/master/dubbo-common/src/main/java/org/apache/dubbo/common/extension.
+ * <a href="https://github.com/apache/dubbo/blob/master/dubbo-common/src/main/java/org/apache/dubbo/common/extension">Apache Dubbo Common Extension</a>.
  *
  * @see ExtensionFactory
  * @see ExtensionLoader

diff --git a/shenyu-web/src/main/java/org/apache/shenyu/web/configuration/ErrorHandlerConfiguration.java b/shenyu-web/src/main/java/org/apache/shenyu/web/configuration/ErrorHandlerConfiguration.java
@@ -96,9 +96,9 @@ public ErrorWebExceptionHandler errorWebExceptionHandler(final ErrorAttributes e
     }
 
     /**
-     * https://github.com/spring-cloud/spring-cloud-gateway/issues/541
      * Hidden http method filter hidden http method filter.
      *
+     * @see <a href="https://github.com/spring-cloud/spring-cloud-gateway/issues/541">issues-541</a>
      * @return the hidden http method filter
      */
     @Bean

diff --git a/shenyu-web/src/main/java/org/apache/shenyu/web/filter/support/BodyInserterContext.java b/shenyu-web/src/main/java/org/apache/shenyu/web/filter/support/BodyInserterContext.java
@@ -29,7 +29,8 @@
 
 /**
  * The type Body inserter context.
- * * @see https://github.com/spring-cloud/spring-cloud-gateway/blob/master/spring-cloud-gateway-core/src/main/java/org/springframework/cloud/gateway/support/BodyInserterContext.java
+ * 
+ * @see <a href="https://github.com/spring-cloud/spring-cloud-gateway/blob/master/spring-cloud-gateway-core/src/main/java/org/springframework/cloud/gateway/support/BodyInserterContext.java">BodyInserterContext</a>
  */
 public class BodyInserterContext implements BodyInserter.Context {
 

diff --git a/shenyu-web/src/main/java/org/apache/shenyu/web/filter/support/CachedBodyOutputMessage.java b/shenyu-web/src/main/java/org/apache/shenyu/web/filter/support/CachedBodyOutputMessage.java
@@ -30,8 +30,9 @@
 import java.util.function.Supplier;
 
 /**
- * * @see https://github.com/spring-cloud/spring-cloud-gateway/blob/master/spring-cloud-gateway-core/src/main/java/org/springframework/cloud/gateway/filter/factory/rewrite/CachedBodyOutputMessage.java
  * Implementation of {@link ClientHttpRequest} that saves body as a field.
+ *
+ * @see <a href="https://github.com/spring-cloud/spring-cloud-gateway/blob/master/spring-cloud-gateway-core/src/main/java/org/springframework/cloud/gateway/filter/factory/rewrite/CachedBodyOutputMessage.java">CachedBodyOutputMessage</a>
  */
 public class CachedBodyOutputMessage implements ReactiveHttpOutputMessage {