Skip to content

Commit 0232848

Browse files
committed
chore: improve documentation of the AutoField annotation
1 parent ad4af63 commit 0232848

File tree

1 file changed

+3
-0
lines changed
  • api/src/main/java/com/interguess/autoimpl/api/annotations

1 file changed

+3
-0
lines changed

api/src/main/java/com/interguess/autoimpl/api/annotations/AutoField.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@
3333
* Annotation to mark a method that's implementation should reference to a specific field.
3434
* E.g. if you have a getter and a setter you set their field name with this annotation to the same value,
3535
* auto-impl will generate getter and setter implementations for their common field.
36+
*
37+
* @implNote This annotation as it does not automatically create a field, it just links methods to a field name so other
38+
* code generators can use the same field name for multiple methods.
3639
*/
3740
@Target({ElementType.METHOD})
3841
public @interface AutoField {

0 commit comments

Comments
 (0)