Repository navigation
Conversation
Zeglow
commented
Oct 22, 2025
Zeglow
commented
Owner
Following AI code review suggestions:Fluent API improvement & enhancing JavaDoc AI assisted with: Fluent API improvement
…dation with null checks (AI-added) ; Enhanced JavaDoc (AI)
AI-assisted: improve existing JavaDoc and comments
Collaborator
|
I think |
espertusnu
approved these changes
Nov 7, 2025
espertusnu
left a comment
espertusnu
left a comment
Collaborator
There was a problem hiding this comment.
Very nice work! Comments are just FYI.
|
|
||
| /** | ||
| * Represents a binding between a text input control and an auto-completion popup | ||
| * Represents a binding between a text input control and an auto-completion popup. |
| * This class is a slightly modified version of {@link impl.org.controlsfx.autocompletion.AutoCompletionTextFieldBinding} | ||
| * that works with general text input controls instead of just text fields. | ||
| * <p> | ||
| * Use the {@link Builder} to create instances of this class. |
| }; | ||
|
|
||
| /** | ||
| * Private constructor to enforce the use of Builder. |
Collaborator
There was a problem hiding this comment.
As you now know, no javadoc for private members.
| * .inputAnalyzer(new CustomStrategy()) | ||
| * .showOnFocus(true) | ||
| * .build(); | ||
| * }</pre> |
| * @param <T> the type of the suggestions | ||
| */ | ||
| public static class Builder<T> { | ||
| // Required parameters |
| /** | ||
| * Represents the link to an external file (e.g. associated PDF file). | ||
| * This class is {@link Serializable} which is needed for drag and drop in gui | ||
| * This class is {@link Serializable} which is needed for drag and drop in gui. |
| * Constructor can also be used for non-valid paths. We need to parse them, because the GUI needs to render it. | ||
| * | ||
| * @param description the file description | ||
| * @param link the file link as string |
Collaborator
There was a problem hiding this comment.
Normally, you wouldn't say "as string" because the type information is shown in javadoc anyway.
|
|
||
| /** | ||
| * Creates a LinkedFile from a local file path. | ||
| * This is the most common way to create a LinkedFile for local files. |
Collaborator
There was a problem hiding this comment.
I would not include information like this in javadoc since it's not part of the API.
| * | ||
| * @param description the file description | ||
| * @param link the file path | ||
| * @param fileType the file type, e.g., "PDF", "TXT" |
Collaborator
There was a problem hiding this comment.
I notice that the @param descriptions here are different from the ones in similar methods. They should ideally all be the same.
| * @param fileType the file type, e.g., "PDF", "TXT" | ||
| * @return a new LinkedFile instance | ||
| */ | ||
| public static LinkedFile of(String description, Path link, String fileType) { |
Collaborator
There was a problem hiding this comment.
I see my instructions were unclear. I did not mean for the static factory methods to all have the same name. For example, this one could be called fromPath() or createFromPath().
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.