aboutsummaryrefslogtreecommitdiff
path: root/src/main/java/ftbsc/lll/processor/annotations/Patch.java
diff options
context:
space:
mode:
author zaaarf <zaaarf@proton.me>2023-02-26 20:16:48 +0100
committer zaaarf <zaaarf@proton.me>2023-02-26 20:16:48 +0100
commit96b2bc553664892d476e0ca35a919eb20c7d1cb2 (patch)
treebbfaf86da6af6bbdc47fa5b8a27d0395e3631c13 /src/main/java/ftbsc/lll/processor/annotations/Patch.java
parenteca2d1f312acd22a3515a377663686b23d9e234b (diff)
chore: added proper documentation, cleaned up build.gradle, added exceptions
Diffstat (limited to 'src/main/java/ftbsc/lll/processor/annotations/Patch.java')
-rw-r--r--src/main/java/ftbsc/lll/processor/annotations/Patch.java17
1 files changed, 15 insertions, 2 deletions
diff --git a/src/main/java/ftbsc/lll/processor/annotations/Patch.java b/src/main/java/ftbsc/lll/processor/annotations/Patch.java
index adbb674..9b0f5da 100644
--- a/src/main/java/ftbsc/lll/processor/annotations/Patch.java
+++ b/src/main/java/ftbsc/lll/processor/annotations/Patch.java
@@ -3,11 +3,24 @@ package ftbsc.lll.processor.annotations;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
-import java.lang.annotation.Target;
+/**
+ * Marks the class as containing an injector for a user-specified {@link Class}.
+ * It will be discarded unless {@link ftbsc.lll.processor.annotations.Target} and
+ * {@link Injector} are properly placed within.
+ * @see Target
+ * @see Injector
+ */
@Retention(RetentionPolicy.SOURCE)
-@Target(ElementType.TYPE)
+@java.lang.annotation.Target(ElementType.TYPE)
public @interface Patch {
+ /**
+ * @return the Minecraft {@link Class} to target for patching
+ */
Class<?> value();
+
+ /**
+ * @return the patching reason, for logging, defaults to "No reason specified."
+ */
String reason() default "No reason specified.";
}