Skip to content

Commit

Permalink
Improve javadoc of ClassInfo.fields(), methods() and recordComponents()
Browse files Browse the repository at this point in the history
  • Loading branch information
Ladicek committed Aug 7, 2024
1 parent 14f072f commit 51f2b12
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions core/src/main/java/org/jboss/jandex/ClassInfo.java
Original file line number Diff line number Diff line change
Expand Up @@ -701,8 +701,10 @@ public final List<AnnotationInstance> classAnnotationsWithRepeatable(DotName nam
* and static initializer blocks which have the special names of {@code <init>}
* and {@code <clinit>}, respectively. It does not, however, include inherited methods.
* These must be discovered by traversing the class hierarchy.
* <p>
* This list may be empty, but is never {@code null}.
* <p>
* Note that the result <em>doesn't</em> have any guaranteed order. If you need
* declaration order, use {@link #unsortedMethods()}.
*
* @return the list of methods declared in this class
*/
Expand Down Expand Up @@ -832,7 +834,10 @@ public final FieldInfo field(String name) {
/**
* Returns a list of all available fields. Only fields declared in this class are available.
* Locating inherited fields requires traversing the class hierarchy. This list may be
* empty, but never null.
* empty, but is never {@code null}.
* <p>
* Note that the result <em>doesn't</em> have any guaranteed order. If you need
* declaration order, use {@link #unsortedFields()}.
*
* @return a list of fields
*/
Expand Down Expand Up @@ -885,9 +890,12 @@ public final RecordComponentInfo recordComponent(String name) {

/**
* Returns a list of all record components declared by this class.
* This list may be empty, but never {@code null}.
* This list may be empty, but is never {@code null}.
* <p>
* If this class is not a record, returns an empty list.
* <p>
* Note that the result <em>doesn't</em> have any guaranteed order. If you need
* declaration order, use {@link #unsortedRecordComponents()}.
*
* @return immutable list of record components
*/
Expand Down

0 comments on commit 51f2b12

Please sign in to comment.