From 96b2bc553664892d476e0ca35a919eb20c7d1cb2 Mon Sep 17 00:00:00 2001 From: zaaarf Date: Sun, 26 Feb 2023 20:16:48 +0100 Subject: chore: added proper documentation, cleaned up build.gradle, added exceptions --- .../java/ftbsc/lll/processor/annotations/Patch.java | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) (limited to 'src/main/java/ftbsc/lll/processor/annotations/Patch.java') 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."; } -- cgit v1.2.3-56-ga3b1