Conversation
CatarinaGamboa
requested changes
Feb 11, 2026
Collaborator
CatarinaGamboa
left a comment
CatarinaGamboa
left a comment
There was a problem hiding this comment.
Let's improve some of the documentation. Think of this as a developer that does not want to go outside the editor to understand how something works so they'll just read what shows in the documentation.
liquidjava-api/src/main/java/liquidjava/specification/ExternalRefinementsFor.java
Outdated
Show resolved
Hide resolved
liquidjava-api/src/main/java/liquidjava/specification/GhostMultiple.java
Outdated
Show resolved
Hide resolved
liquidjava-api/src/main/java/liquidjava/specification/Refinement.java
Outdated
Show resolved
Hide resolved
liquidjava-api/src/main/java/liquidjava/specification/Refinement.java
Outdated
Show resolved
Hide resolved
liquidjava-api/src/main/java/liquidjava/specification/RefinementAlias.java
Outdated
Show resolved
Hide resolved
liquidjava-api/src/main/java/liquidjava/specification/RefinementPredicateMultiple.java
Outdated
Show resolved
Hide resolved
liquidjava-api/src/main/java/liquidjava/specification/StateRefinement.java
Show resolved
Hide resolved
liquidjava-api/src/main/java/liquidjava/specification/StateRefinementMultiple.java
Outdated
Show resolved
Hide resolved
liquidjava-api/src/main/java/liquidjava/specification/StateSet.java
Outdated
Show resolved
Hide resolved
liquidjava-api/src/main/java/liquidjava/specification/StateSets.java
Outdated
Show resolved
Hide resolved
CatarinaGamboa
approved these changes
Feb 13, 2026
Collaborator
CatarinaGamboa
left a comment
CatarinaGamboa
left a comment
There was a problem hiding this comment.
Some comments left to improve examples and not have examples if we don't want people using them that way
| * } | ||
| * </pre> | ||
| */ | ||
| public String value(); |
Collaborator
Author
There was a problem hiding this comment.
Intellij gave me a warning saying that methods in interfaces are always public so that's redundant
liquidjava-api/src/main/java/liquidjava/specification/Refinement.java
Outdated
Show resolved
Hide resolved
liquidjava-api/src/main/java/liquidjava/specification/StateRefinement.java
Show resolved
Hide resolved
liquidjava-api/src/main/java/liquidjava/specification/StateSet.java
Outdated
Show resolved
Hide resolved
| import liquidjava.specification.StateRefinement; | ||
|
|
||
| @Ghost("boolean opened") | ||
| @Ghost(value="boolean opened") |
Collaborator
There was a problem hiding this comment.
why value = ?? just to show its possible?
Collaborator
Author
There was a problem hiding this comment.
Claude probably changed that when I asked it to format the Javadocs in the annotations 😂
...le/src/main/java/testSuite/classes/conflicting_ghost_names_correct/ArrayListRefinements.java
Outdated
Show resolved
Hide resolved
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.
This PR improves the documentation of the API annotations.