Skip to content

Commit 927dc0b

Browse files
committed
Fix JavaDoc escaping in ConvenienceMethodGenerator
Fix compilation errors in CI caused by double-escaped newlines in JavaDoc comments. Change \\n to \n in addJavadoc calls to generate proper JavaDoc without illegal characters.
1 parent 2ccf0cc commit 927dc0b

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

src/main/java/com/github/wassertim/dynamodb/toolkit/generation/ConvenienceMethodGenerator.java

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -62,11 +62,11 @@ private MethodSpec generateFromDynamoDbItemsMethod(String className, ClassName d
6262
ClassName.get(Map.class),
6363
ClassName.get(String.class),
6464
attributeValue)), "items")
65-
.addJavadoc("Convenience method to convert a list of DynamoDB items to domain objects.\\n")
66-
.addJavadoc("Handles the common pattern of mapping QueryResponse.items() to domain objects.\\n")
67-
.addJavadoc("\\n")
68-
.addJavadoc("@param items List of DynamoDB items from QueryResponse.items() or ScanResponse.items()\\n")
69-
.addJavadoc("@return List of $L objects, filtering out any null results\\n", className)
65+
.addJavadoc("Convenience method to convert a list of DynamoDB items to domain objects.\n")
66+
.addJavadoc("Handles the common pattern of mapping QueryResponse.items() to domain objects.\n")
67+
.addJavadoc("\n")
68+
.addJavadoc("@param items List of DynamoDB items from QueryResponse.items() or ScanResponse.items()\n")
69+
.addJavadoc("@return List of $L objects, filtering out any null results\n", className)
7070
.beginControlFlow("if (items == null || items.isEmpty())")
7171
.addStatement("return new $T<>()", ClassName.get("java.util", "ArrayList"))
7272
.endControlFlow()
@@ -86,11 +86,11 @@ private MethodSpec generateToDynamoDbItemMethod(String className, ClassName doma
8686
ClassName.get(String.class),
8787
attributeValue))
8888
.addParameter(domainClass, "object")
89-
.addJavadoc("Convenience method to convert a single domain object to a DynamoDB item.\\n")
90-
.addJavadoc("Useful for PutItem operations.\\n")
91-
.addJavadoc("\\n")
92-
.addJavadoc("@param object The $L object to convert\\n", className)
93-
.addJavadoc("@return DynamoDB item (Map<String, AttributeValue>), or null if input is null or conversion fails\\n")
89+
.addJavadoc("Convenience method to convert a single domain object to a DynamoDB item.\n")
90+
.addJavadoc("Useful for PutItem operations.\n")
91+
.addJavadoc("\n")
92+
.addJavadoc("@param object The $L object to convert\n", className)
93+
.addJavadoc("@return DynamoDB item (Map<String, AttributeValue>), or null if input is null or conversion fails\n")
9494
.beginControlFlow("if (object == null)")
9595
.addStatement("return null")
9696
.endControlFlow()
@@ -109,11 +109,11 @@ private MethodSpec generateToDynamoDbItemsMethod(String className, ClassName dom
109109
ClassName.get(String.class),
110110
attributeValue)))
111111
.addParameter(ParameterizedTypeName.get(ClassName.get(List.class), domainClass), "objects")
112-
.addJavadoc("Convenience method to convert a list of domain objects to DynamoDB items.\\n")
113-
.addJavadoc("Useful for batch operations like batchWriteItem.\\n")
114-
.addJavadoc("\\n")
115-
.addJavadoc("@param objects List of $L objects to convert\\n", className)
116-
.addJavadoc("@return List of DynamoDB items (Map<String, AttributeValue>), filtering out any null results\\n")
112+
.addJavadoc("Convenience method to convert a list of domain objects to DynamoDB items.\n")
113+
.addJavadoc("Useful for batch operations like batchWriteItem.\n")
114+
.addJavadoc("\n")
115+
.addJavadoc("@param objects List of $L objects to convert\n", className)
116+
.addJavadoc("@return List of DynamoDB items (Map<String, AttributeValue>), filtering out any null results\n")
117117
.beginControlFlow("if (objects == null || objects.isEmpty())")
118118
.addStatement("return new $T<>()", ClassName.get("java.util", "ArrayList"))
119119
.endControlFlow()

0 commit comments

Comments
 (0)