summaryrefslogtreecommitdiff
path: root/src/main/java/ftbsc/lll/tools/DescriptorBuilder.java
diff options
context:
space:
mode:
author zaaarf <zaaarf@proton.me>2023-03-21 18:33:53 +0100
committer zaaarf <zaaarf@proton.me>2023-03-21 18:33:53 +0100
commit7e0b4e58dd9cf0c3d2f1b120ce21fe986d417f82 (patch)
tree8761fec9ec03d85047c24ac4831d6677387edde8 /src/main/java/ftbsc/lll/tools/DescriptorBuilder.java
parentff47129cf3ac12817bf4ca9af8753592298f03e4 (diff)
chore: javadocs
Diffstat (limited to 'src/main/java/ftbsc/lll/tools/DescriptorBuilder.java')
-rw-r--r--src/main/java/ftbsc/lll/tools/DescriptorBuilder.java16
1 files changed, 7 insertions, 9 deletions
diff --git a/src/main/java/ftbsc/lll/tools/DescriptorBuilder.java b/src/main/java/ftbsc/lll/tools/DescriptorBuilder.java
index 252c2a8..1b33790 100644
--- a/src/main/java/ftbsc/lll/tools/DescriptorBuilder.java
+++ b/src/main/java/ftbsc/lll/tools/DescriptorBuilder.java
@@ -32,10 +32,9 @@ public class DescriptorBuilder {
/**
* Sets the return type to the given type.
- * @implNote Passing a {@link Class} may cause problems if used with objects outside
- * the Java SDK. Pass the fully qualified name as a {@link String} rather
- * than the {@link Class} object for non-standard types (such as Minecraft
- * classes).
+ * Passing a {@link Class} may cause problems if used with objects outside the Java
+ * SDK. Pass the fully qualified name as a {@link String} rather than the {@link Class}
+ * object for non-standard types.
* @param returnType the Class object corresponding to the return type
* @return the builder's state after the change
*/
@@ -72,10 +71,9 @@ public class DescriptorBuilder {
/**
* Adds a parameter of the given class type to the method.
* Parameter order matters.
- * @implNote Passing a {@link Class} may cause problems if used with objects outside
- * the Java SDK. Pass the fully qualified name as a {@link String} rather
- * than the {@link Class} object for non-standard types (such as Minecraft
- * classes).
+ * Passing a {@link Class} may cause problems if used with objects outside the Java
+ * SDK. Pass the fully qualified name as a {@link String} rather than the {@link Class}
+ * object for non-standard types.
* @param param the Class object corresponding to the parameter
* @return the builder's state after the change
*/
@@ -114,7 +112,7 @@ public class DescriptorBuilder {
/**
* Builds the descriptor into a string.
- * Example result: int m(Object[] o) -> ([Ljava/lang/Object;)I
+ * Example result: {@code int m(Object[] o)} becomes {@code ([Ljava/lang/Object;)I}
* @return the resulting descriptor
*/
public String build() {