Add Javadoc to qualifers for viewpoint test checker (#1021)

eisop · Dec 22, 2024 · 3d43fa3 · 3d43fa3
1 parent ab0a9e7
commit 3d43fa3
Show file tree

Hide file tree

Showing 7 changed files with 9 additions and 3 deletions.
diff --git a/framework/src/test/java/viewpointtest/quals/A.java b/framework/src/test/java/viewpointtest/quals/A.java
@@ -8,6 +8,7 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+/** The A qualifier. */
 @Documented
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.TYPE_USE, ElementType.TYPE_PARAMETER})

diff --git a/framework/src/test/java/viewpointtest/quals/B.java b/framework/src/test/java/viewpointtest/quals/B.java
@@ -8,6 +8,7 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+/** The B qualifier. */
 @Documented
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.TYPE_USE, ElementType.TYPE_PARAMETER})

diff --git a/framework/src/test/java/viewpointtest/quals/Bottom.java b/framework/src/test/java/viewpointtest/quals/Bottom.java
@@ -10,6 +10,7 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+/** The Bottom qualifier. */
 @Documented
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.TYPE_USE, ElementType.TYPE_PARAMETER})

diff --git a/framework/src/test/java/viewpointtest/quals/Lost.java b/framework/src/test/java/viewpointtest/quals/Lost.java
@@ -9,11 +9,11 @@
 import java.lang.annotation.Target;
 
 /**
- * The {@link Lost} qualifier indicates that a relationship cannot be expressed. It is the result of
+ * The Lost qualifier indicates that a relationship cannot be expressed. It is the result of
  * viewpoint adaptation that combines {@link Top} and {@link ReceiverDependentQual}.
  *
- * <p>It is not reflexive in the subtyping relationship and the only subtype for {@link Lost} is
- * {@link Bottom}.
+ * <p>It is not reflexive in the subtyping relationship and the only subtype for Lost is {@link
+ * Bottom}.
  */
 @Documented
 @Retention(RetentionPolicy.RUNTIME)

diff --git a/framework/src/test/java/viewpointtest/quals/PolyVP.java b/framework/src/test/java/viewpointtest/quals/PolyVP.java
@@ -8,6 +8,7 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+/** The PolyVP qualifier is a polymorphic qualifier in this hierarchy. */
 @Documented
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.TYPE_USE, ElementType.TYPE_PARAMETER})

diff --git a/framework/src/test/java/viewpointtest/quals/ReceiverDependentQual.java b/framework/src/test/java/viewpointtest/quals/ReceiverDependentQual.java
@@ -8,6 +8,7 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+/** The ReceiverDependentQual qualifier. */
 @Documented
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.TYPE_USE, ElementType.TYPE_PARAMETER})

diff --git a/framework/src/test/java/viewpointtest/quals/Top.java b/framework/src/test/java/viewpointtest/quals/Top.java
@@ -9,6 +9,7 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+/** The Top qualifier. */
 @Documented
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.TYPE_USE, ElementType.TYPE_PARAMETER})