Skip to content

Commit

Permalink
refactor(smart-doc): Update warnings for Object usage in collections …
Browse files Browse the repository at this point in the history
…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.
  • Loading branch information
linwumingshi committed Sep 27, 2024
1 parent 858913a commit 94bbe7d
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 5 deletions.
12 changes: 12 additions & 0 deletions src/main/java/com/ly/doc/constants/DocGlobalConstants.java
Original file line number Diff line number Diff line change
Expand Up @@ -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.\"}";

}
7 changes: 2 additions & 5 deletions src/main/java/com/ly/doc/helper/JsonBuildHelper.java
Original file line number Diff line number Diff line change
Expand Up @@ -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(",");
Expand Down Expand Up @@ -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;
}

Expand Down

0 comments on commit 94bbe7d

Please sign in to comment.