improve javadoc of VoidType and MethodInfo

smallrye · Jan 24, 2024 · d10e95d · d10e95d
1 parent 14591a4
commit d10e95d
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 4 deletions.
diff --git a/core/src/main/java/org/jboss/jandex/MethodInfo.java b/core/src/main/java/org/jboss/jandex/MethodInfo.java
@@ -35,9 +35,8 @@
  * However, {@link #descriptorParameterTypes()} and {@link #descriptorParametersCount()}
  * may be used to obtain information about all parameters, including mandated and synthetic.
  * <p>
- * As an exception to the rule above, in case of well known methods where no parameter
- * is declared explicitly, the implicitly declared parameters are included. This currently
- * applies to the implicitly declared parameters of:
+ * As an exception to the rule above, implicitly declared parameters are always included
+ * in case of methods that don't have an explicit parameter list. These are:
  * <ul>
  * <li>the implicitly declared {@code valueOf()} method in enums;</li>
  * <li>the compact constructor in records.</li>

diff --git a/core/src/main/java/org/jboss/jandex/VoidType.java b/core/src/main/java/org/jboss/jandex/VoidType.java
@@ -19,7 +19,7 @@
 package org.jboss.jandex;
 
 /**
- * Specifies "void" in a method signature.
+ * Represents the {@code void} pseudo-type, which may appear in a method signature.
  *
  * @since 2.0
  * @author Jason T. Greene