From d528d472a1d2024fd55d0d2dfe2221929fe0856a Mon Sep 17 00:00:00 2001 From: zaaarf Date: Sat, 10 Jun 2023 20:47:09 +0200 Subject: [PATCH] chore: documentation fixes --- src/main/java/ftbsc/lll/processor/LilleroProcessor.java | 2 +- src/main/java/ftbsc/lll/processor/annotations/Injector.java | 6 +++--- src/main/java/ftbsc/lll/processor/annotations/Target.java | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/main/java/ftbsc/lll/processor/LilleroProcessor.java b/src/main/java/ftbsc/lll/processor/LilleroProcessor.java index 0f6935a..b1d1f1e 100644 --- a/src/main/java/ftbsc/lll/processor/LilleroProcessor.java +++ b/src/main/java/ftbsc/lll/processor/LilleroProcessor.java @@ -99,7 +99,7 @@ public class LilleroProcessor extends AbstractProcessor { /** * This checks whether a given class contains the requirements to be parsed into a Lillero injector. * It must have at least one method annotated with {@link Target}, and one method annotated with {@link Injector} - * that must take in a ClassNode and MethodNode from ObjectWeb's ASM library. + * that must take in either a ClassNode and MethodNode (from ObjectWeb's ASM library) or only a MethodNode. * @param elem the element to check. * @return whether it can be converted into a valid {@link IInjector}. */ diff --git a/src/main/java/ftbsc/lll/processor/annotations/Injector.java b/src/main/java/ftbsc/lll/processor/annotations/Injector.java index d9d3b09..ab4285e 100644 --- a/src/main/java/ftbsc/lll/processor/annotations/Injector.java +++ b/src/main/java/ftbsc/lll/processor/annotations/Injector.java @@ -6,10 +6,10 @@ import java.lang.annotation.RetentionPolicy; /** * Marks a method as the injector method for purposes of generation. - * The method itself should take in a ClassNode and MethodNode (from the ObjectWeb ASM library) - * as parameters. It will be discarded otherwise. + * The method itself should take in as parameters a ClassNode and a MethodNode (from the ObjectWeb + * ASM library), or only a MethodNode. The annotation will be ignored otherwise. * It will also be discarded unless the containing class is annotated with {@link Patch} - * and another method within the class is annotated with {@link Target}. + * and at least another method within the class is annotated with {@link Target}. * This annotation may be added multiple times, in order to target multiple methods. * @see Patch * @see Target diff --git a/src/main/java/ftbsc/lll/processor/annotations/Target.java b/src/main/java/ftbsc/lll/processor/annotations/Target.java index 3152d1d..a809b4c 100644 --- a/src/main/java/ftbsc/lll/processor/annotations/Target.java +++ b/src/main/java/ftbsc/lll/processor/annotations/Target.java @@ -10,7 +10,7 @@ import java.lang.annotation.RetentionPolicy; * The method annotated with this, called "stub" within the documentation, should have the * same name and parameters as the method it's supposed to represent. * It will be discarded unless the containing class is annotated with {@link Patch} - * and another method within the class is annotated with {@link Injector}. + * and at least another method within the class is annotated with {@link Injector}. * @see Patch * @see Injector */