zaaarf/lillero-processor
1
0
Fork 0
mirror of https://github.com/zaaarf/lillero-processor.git synced 2024-11-10 05:59:18 +01:00
Code Issues Projects Releases Packages Wiki Activity

chore: documentation fixes

Browse source
This commit is contained in:
zaaarf 2023-06-10 20:47:09 +02:00
parent a90af3bb4b
commit d528d472a1
No known key found for this signature in database
GPG key ID: 82240E075E31FA4C
3 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
src/main/java/ftbsc/lll/processor/LilleroProcessor.java
View file

@ -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. * 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} * 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. * @param elem the element to check.
* @return whether it can be converted into a valid {@link IInjector}. * @return whether it can be converted into a valid {@link IInjector}.
*/ */

6
src/main/java/ftbsc/lll/processor/annotations/Injector.java
View file

@ -6,10 +6,10 @@ import java.lang.annotation.RetentionPolicy;
/** /**
* Marks a method as the injector method for purposes of generation. * 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) * The method itself should take in as parameters a ClassNode and a MethodNode (from the ObjectWeb
* as parameters. It will be discarded otherwise. * 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} * 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. * This annotation may be added multiple times, in order to target multiple methods.
* @see Patch * @see Patch
* @see Target * @see Target

2
src/main/java/ftbsc/lll/processor/annotations/Target.java
View file

@ -10,7 +10,7 @@ import java.lang.annotation.RetentionPolicy;
* The method annotated with this, called "stub" within the documentation, should have the * 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. * 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} * 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 Patch
* @see Injector * @see Injector
*/ */