Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve javadoc of ClassInfo.fields(), methods() and recordComponents() #417

Merged
merged 1 commit into from
Aug 7, 2024
+11 −3
Merged

Improve javadoc of ClassInfo.fields(), methods() and recordComponents() #417

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions core/src/main/java/org/jboss/jandex/ClassInfo.java
View file
Open in desktop
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