Copilot commented on code in PR #1812:
URL: https://github.com/apache/struts/pull/1812#discussion_r3652858758


##########
core/src/main/java/org/apache/struts2/conversion/annotations/TypeConversion.java:
##########
@@ -67,8 +74,11 @@
  * <tr>
  * <td>key</td>
  * <td>no</td>
- * <td>The annotated property/key name</td>
- * <td>The optional property name mostly used within TYPE level 
annotations.</td>
+ * <td>The resolved property name on a method; the field's own name on a 
field</td>
+ * <td>The property name the rule applies to. The matching prefix for the 
given rule
+ * (<code>Key_</code>, <code>Element_</code>, <code>KeyProperty_</code>, 
<code>CreateIfNull_</code>, or the deprecated
+ * <code>Collection_</code>) is prepended automatically unless the key already 
carries it. Required on TYPE level annotations,
+ * where there is no member name to derive it from.</td>

Review Comment:
   The `key` parameter table lists an effective default for methods/fields, but 
it doesn’t mention that `key` is required when `@TypeConversion` is used inside 
a class-level `@Conversion(conversions=...)` (where there’s no member name to 
derive from). As written, the “Default” column can be read as universally 
applicable, which contradicts the class-level requirement enforced by 
`XWorkConverter.processClassLevelAnnotations`. Consider updating the row to 
explicitly call out the per-context default/requirement.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to