From 94bbe7d2b947bc57c2f9ff48d798f26fcdecbfa6 Mon Sep 17 00:00:00 2001
From: linwumingshi <linwumingshi@gmail.com>
Date: Fri, 27 Sep 2024 21:16:33 +0800
Subject: [PATCH] refactor(smart-doc): Update warnings for Object usage in
 collections and map values

- Fix spelling errors in warning messages ("waring" to "warning").
- Update warning messages to provide clearer guidance on using specific types instead of `java.util.Object` for better documentation with SmartDoc.
---
 .../com/ly/doc/constants/DocGlobalConstants.java     | 12 ++++++++++++
 src/main/java/com/ly/doc/helper/JsonBuildHelper.java |  7 ++-----
 2 files changed, 14 insertions(+), 5 deletions(-)

diff --git a/src/main/java/com/ly/doc/constants/DocGlobalConstants.java b/src/main/java/com/ly/doc/constants/DocGlobalConstants.java
index bc8eeb6a9..76d33611c 100644
--- a/src/main/java/com/ly/doc/constants/DocGlobalConstants.java
+++ b/src/main/java/com/ly/doc/constants/DocGlobalConstants.java
@@ -614,4 +614,16 @@ public interface DocGlobalConstants {
 	 */
 	String DEFAULT_MAP_KEY_DESC = "A map key.";
 
+	/**
+	 * object map value warning.
+	 */
+	String OBJECT_MAP_VALUE_WARNING = "{\"warning\":\"Using java.util.Object as a Map value is not recommended. "
+			+ "Smart-doc cannot process it properly. Please use a specific type for better documentation generation.\"}";
+
+	/**
+	 * object list warning.
+	 */
+	String GENERIC_LIST_WARNING = "{\"warning\":\"Using java.util.Object in a List instead of a specific generic type is not recommended. "
+			+ "Smart-doc cannot display the correct generics. Please specify the generic type for better documentation generation.\"}";
+
 }
diff --git a/src/main/java/com/ly/doc/helper/JsonBuildHelper.java b/src/main/java/com/ly/doc/helper/JsonBuildHelper.java
index 8fc4967aa..eb18b744c 100644
--- a/src/main/java/com/ly/doc/helper/JsonBuildHelper.java
+++ b/src/main/java/com/ly/doc/helper/JsonBuildHelper.java
@@ -192,7 +192,7 @@ public static String buildJson(String typeName, String genericCanonicalName, boo
 			String gName = JavaClassValidateUtil.isArray(gNameTemp) ? gNameTemp.substring(0, gNameTemp.indexOf("["))
 					: globGicName[0];
 			if (JavaTypeConstants.JAVA_OBJECT_FULLY.equals(gName)) {
-				data.append("{\"waring\":\"You may use java.util.Object instead of display generics in the List\"}");
+				data.append(DocGlobalConstants.GENERIC_LIST_WARNING);
 			}
 			else if (JavaClassValidateUtil.isPrimitive(gName)) {
 				data.append(DocUtil.jsonValueByType(gName)).append(",");
@@ -557,10 +557,7 @@ public static void buildMapJson(String genericCanonicalName, boolean isResp, int
 
 		// when map value is Object
 		if (JavaTypeConstants.JAVA_OBJECT_FULLY.equals(gicName)) {
-			data.append("{")
-				.append("\"mapKey\":")
-				.append("{\"waring\":\"You may use java.util.Object for Map value; smart-doc can't be handle.\"}")
-				.append("}");
+			data.append("{").append("\"mapKey\":").append(DocGlobalConstants.OBJECT_MAP_VALUE_WARNING).append("}");
 			return;
 		}