aboutsummaryrefslogtreecommitdiff
path: root/src/main/java/ftbsc/lll/processor/annotations/FindField.java
diff options
context:
space:
mode:
author zaaarf <zaaarf@proton.me>2023-03-16 10:56:46 +0100
committer zaaarf <zaaarf@proton.me>2023-03-16 10:56:46 +0100
commitf85c868e10fead010a58f5310b33a8396379b70b (patch)
treeebcadace2860a778e00544e66ef3d7fd5dfdff24 /src/main/java/ftbsc/lll/processor/annotations/FindField.java
parent062f8117b9f00459c52d91e3e30b5e65e77604d7 (diff)
chore: javadocs for annotations
Diffstat (limited to 'src/main/java/ftbsc/lll/processor/annotations/FindField.java')
-rw-r--r--src/main/java/ftbsc/lll/processor/annotations/FindField.java10
1 files changed, 10 insertions, 0 deletions
diff --git a/src/main/java/ftbsc/lll/processor/annotations/FindField.java b/src/main/java/ftbsc/lll/processor/annotations/FindField.java
index c13fd46..40de173 100644
--- a/src/main/java/ftbsc/lll/processor/annotations/FindField.java
+++ b/src/main/java/ftbsc/lll/processor/annotations/FindField.java
@@ -16,6 +16,16 @@ import java.lang.annotation.RetentionPolicy;
@Retention(RetentionPolicy.CLASS)
@java.lang.annotation.Target(ElementType.METHOD)
public @interface FindField {
+ /**
+ * @return the {@link Class} object containing the desired field,
+ * or the {@link Object} class if not specified (the {@link Class}
+ * from {@link Patch#value()} is instead used)
+ */
Class<?> parent() default Object.class;
+
+ /**
+ * @return the name of the field, will default to the empty string
+ * (the name of the annotated method will instead be used)
+ */
String name() default "";
}