Skip to content

Commit

Permalink
Fix wording in doc comments
Browse files Browse the repository at this point in the history
Co-authored-by: Hinduja Balasubramaniyam <[email protected]>
  • Loading branch information
heshanpadmasiri and HindujaB committed Feb 12, 2024
1 parent c0c17f8 commit b044eba
Showing 1 changed file with 11 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,18 @@ public interface Type {
// TODO: remove default implementations when standard library types are updated
/**
* Set the referred type for this type once it has been calculated. This must be called the first time this
* calculation is done in order for {@code Type#getReferredTypeCache()} to work properly. This is non-blocking and
* will become eventually consistent. Expect {@code TypeUtils#getReferredType(Type)} tobe referentially transparent.
* calculation is done for {@code Type#getReferredTypeCache()} to work properly. This is non-blocking and
* will eventually become consistent. Expect {@code TypeUtils#getReferredType(Type)} to be referentially
* transparent.
*
* @param type Type referred by this type. For non-reference types, this is the same type.
*/
default void setCachedReferredType(Type type) {
}

Check warning on line 44 in bvm/ballerina-runtime/src/main/java/io/ballerina/runtime/api/types/Type.java

View check run for this annotation

Codecov / codecov/patch

bvm/ballerina-runtime/src/main/java/io/ballerina/runtime/api/types/Type.java#L44

Added line #L44 was not covered by tests
/**
* Get the type referred by this type if it has been already calculated. If it has not been already calculated will
* return null. For non-reference types, this will return the same type. This is non-blocking and will become
* eventually consistent. Expect {@code TypeUtils#getReferredType(Type)} tobe referentially transparent.
* Get the type referred by this type if it has been already calculated. If it has not been already calculated, it
* will return null. For non-reference types, this will return the same type. This is non-blocking and will
* eventually become consistent. Expect {@code TypeUtils#getReferredType(Type)} to be referentially transparent.
*
* @return Referred type of the type
*/
Expand All @@ -54,18 +55,18 @@ default Type getCachedReferredType() {

/**
* Set the implied type for this type once it has been calculated. This must be called the first time this
* calculation is done in order for {@code Type#getImpliedTypeCache()} to work properly. This is non-blocking and
* will become eventually consistent. Expect {@code TypeUtils#getImpliedType(Type)} tobe referentially transparent.
* calculation is done for {@code Type#getImpliedTypeCache()} to work properly. This is non-blocking and
* will eventually become consistent. Expect {@code TypeUtils#getImpliedType(Type)} to be referentially transparent.
*
* @param type Type implied by this type. For non-intersection types, this is the same type.
*/
default void setCachedImpliedType(Type type) {
}

Check warning on line 64 in bvm/ballerina-runtime/src/main/java/io/ballerina/runtime/api/types/Type.java

View check run for this annotation

Codecov / codecov/patch

bvm/ballerina-runtime/src/main/java/io/ballerina/runtime/api/types/Type.java#L64

Added line #L64 was not covered by tests

/**
* Get the type implied by this type if it has been already calculated. If it has not been already calculated will
* return null. For non-intersection types, this will return the same type. This is non-blocking and will become
* eventually consistent. Expect {@code TypeUtils#getImpliedType(Type)} tobe referentially transparent.
* Get the type implied by this type if it has been already calculated. If it has not been already calculated, it
* will return null. For non-intersection types, this will return the same type. This is non-blocking and will
* eventually become consistent. Expect {@code TypeUtils#getImpliedType(Type)} to be referentially transparent.
*
* @return Implied type of the type
*/
Expand Down

0 comments on commit b044eba

Please sign in to comment.