Skip to content
This repository was archived by the owner on Dec 4, 2025. It is now read-only.

Commit 94bbe7d

Browse files
committed
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.
1 parent 858913a commit 94bbe7d

2 files changed

Lines changed: 14 additions & 5 deletions

File tree

src/main/java/com/ly/doc/constants/DocGlobalConstants.java

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -614,4 +614,16 @@ public interface DocGlobalConstants {
614614
*/
615615
String DEFAULT_MAP_KEY_DESC = "A map key.";
616616

617+
/**
618+
* object map value warning.
619+
*/
620+
String OBJECT_MAP_VALUE_WARNING = "{\"warning\":\"Using java.util.Object as a Map value is not recommended. "
621+
+ "Smart-doc cannot process it properly. Please use a specific type for better documentation generation.\"}";
622+
623+
/**
624+
* object list warning.
625+
*/
626+
String GENERIC_LIST_WARNING = "{\"warning\":\"Using java.util.Object in a List instead of a specific generic type is not recommended. "
627+
+ "Smart-doc cannot display the correct generics. Please specify the generic type for better documentation generation.\"}";
628+
617629
}

src/main/java/com/ly/doc/helper/JsonBuildHelper.java

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ public static String buildJson(String typeName, String genericCanonicalName, boo
192192
String gName = JavaClassValidateUtil.isArray(gNameTemp) ? gNameTemp.substring(0, gNameTemp.indexOf("["))
193193
: globGicName[0];
194194
if (JavaTypeConstants.JAVA_OBJECT_FULLY.equals(gName)) {
195-
data.append("{\"waring\":\"You may use java.util.Object instead of display generics in the List\"}");
195+
data.append(DocGlobalConstants.GENERIC_LIST_WARNING);
196196
}
197197
else if (JavaClassValidateUtil.isPrimitive(gName)) {
198198
data.append(DocUtil.jsonValueByType(gName)).append(",");
@@ -557,10 +557,7 @@ public static void buildMapJson(String genericCanonicalName, boolean isResp, int
557557

558558
// when map value is Object
559559
if (JavaTypeConstants.JAVA_OBJECT_FULLY.equals(gicName)) {
560-
data.append("{")
561-
.append("\"mapKey\":")
562-
.append("{\"waring\":\"You may use java.util.Object for Map value; smart-doc can't be handle.\"}")
563-
.append("}");
560+
data.append("{").append("\"mapKey\":").append(DocGlobalConstants.OBJECT_MAP_VALUE_WARNING).append("}");
564561
return;
565562
}
566563

0 commit comments

Comments
 (0)