From 248449ada045a64232be5ba9efd6fdaae6cdd9f8 Mon Sep 17 00:00:00 2001
From: Andy Cheung <micro_zx@msn.cn>
Date: Mon, 11 Sep 2023 16:00:55 +0800
Subject: [PATCH] Add Javadoc of ErrorTypeAwareLogger. (#13032)

---
 .../dubbo/common/logger/ErrorTypeAwareLogger.java | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/dubbo-common/src/main/java/org/apache/dubbo/common/logger/ErrorTypeAwareLogger.java b/dubbo-common/src/main/java/org/apache/dubbo/common/logger/ErrorTypeAwareLogger.java
index fe9ebcc774..72db45e868 100644
--- a/dubbo-common/src/main/java/org/apache/dubbo/common/logger/ErrorTypeAwareLogger.java
+++ b/dubbo-common/src/main/java/org/apache/dubbo/common/logger/ErrorTypeAwareLogger.java
@@ -17,8 +17,23 @@
 
 package org.apache.dubbo.common.logger;
 
+import org.apache.dubbo.common.constants.LoggerCodeConstants;
+
 /**
  * Logger interface with the ability of displaying solution of different types of error.
+ *
+ * <p>
+ * This logger will log a message like this:
+ *
+ * <blockquote><pre>
+ *     ... (original logging message) This may be caused by (... cause),
+ *     go to https://dubbo.apache.org/faq/[Cat]/[X] to find instructions. (... extendedInformation)
+ * </pre></blockquote>
+ *
+ * Where "[Cat]/[X]" is the error code ("code" in arguments). The link is clickable, leading user to
+ * the "Error code and its corresponding solutions" page.
+ *
+ * @see LoggerCodeConstants Detailed Format of Error Code and Error Code Constants
  */
 public interface ErrorTypeAwareLogger extends Logger {