* {@literal @}Format({GENERAL, INT}) String f = "String '%s' has length %d";
*
- * String.format(f, "Example", 7);
+ * String.format(f, "Example", 7);
*
*
*
diff --git a/src/java.base/share/classes/org/checkerframework/checker/index/qual/IndexOrLow.java b/src/java.base/share/classes/org/checkerframework/checker/index/qual/IndexOrLow.java
index 594a6b3bb14..c4b1033413c 100644
--- a/src/java.base/share/classes/org/checkerframework/checker/index/qual/IndexOrLow.java
+++ b/src/java.base/share/classes/org/checkerframework/checker/index/qual/IndexOrLow.java
@@ -14,9 +14,9 @@
* {@code String.indexOf(String)} method is declared as
*
*
- * class String {
+ * class String {
* {@literal @}IndexOrLow("this") int indexOf(String str) { ... }
- * }
+ * }
* Writing {@code @IndexOrLow("arr")} is equivalent to writing {@link diff --git a/src/java.base/share/classes/org/checkerframework/checker/nonempty/qual/EnsuresNonEmpty.java b/src/java.base/share/classes/org/checkerframework/checker/nonempty/qual/EnsuresNonEmpty.java index 17993d6c3e6..cf7603dcd0f 100644 --- a/src/java.base/share/classes/org/checkerframework/checker/nonempty/qual/EnsuresNonEmpty.java +++ b/src/java.base/share/classes/org/checkerframework/checker/nonempty/qual/EnsuresNonEmpty.java @@ -19,19 +19,19 @@ * effect: * *
- * {@literal @}EnsuresNonEmpty("ids")
- * void addId(String id) {
- * ids.add(id);
- * }
+ * {@literal @}EnsuresNonEmpty("ids")
+ * void addId(String id) {
+ * ids.add(id);
+ * }
*
- * /** Throws an exception if the argument is empty. */
- * {@literal @}EnsuresNonEmpty("#1")
- * void useTheMap(Map<T, U> arg) { ... }
+ * /** Throws an exception if the argument is empty. */
+ * {@literal @}EnsuresNonEmpty("#1")
+ * void useTheMap(Map<T, U> arg) { ... }
* Here is an example use: * *
- * {@literal @}AssertNonNullIfNonNull("id")
- * {@literal @}Pure
- * public @Nullable Long getId() {
- * return id;
- * }
+ * {@literal @}AssertNonNullIfNonNull("id")
+ * {@literal @}Pure
+ * public @Nullable Long getId() {
+ * return id;
+ * }
* This postcondition annotation is useful for methods that construct a present Optional: * *
- * {@literal @}EnsuresPresent("optStr")
- * void initialize() {
- * optStr = Optional.of("abc");
- * }
+ * {@literal @}EnsuresPresent("optStr")
+ * void initialize() {
+ * optStr = Optional.of("abc");
+ * }
*
- * /** Throws an exception if the argument is empty. */
- * {@literal @}EnsuresPresent("#1")
- * void useTheOptional(Optional<T> arg) { ... }
+ * /** Throws an exception if the argument is empty. */
+ * {@literal @}EnsuresPresent("#1")
+ * void useTheOptional(Optional<T> arg) { ... }
* Here is an example use: * *
- * {@literal @}EnsuresQualifierIf(result = true, expression = "#1", qualifier = Odd.class)
- * boolean isOdd(int p1, int p2) {
- * return p1 % 2 == 1;
- * }
+ * {@literal @}EnsuresQualifierIf(result = true, expression = "#1", qualifier = Odd.class)
+ * boolean isOdd(int p1, int p2) {
+ * return p1 % 2 == 1;
+ * }
* This annotation is only applicable to methods with a boolean return type. diff --git a/src/java.base/share/classes/org/checkerframework/framework/qual/PostconditionAnnotation.java b/src/java.base/share/classes/org/checkerframework/framework/qual/PostconditionAnnotation.java index 1678614c67c..62392f02d1c 100644 --- a/src/java.base/share/classes/org/checkerframework/framework/qual/PostconditionAnnotation.java +++ b/src/java.base/share/classes/org/checkerframework/framework/qual/PostconditionAnnotation.java @@ -31,8 +31,8 @@ * org.checkerframework.common.value.qual.MinLen} qualifier: * *
- * {@literal @}PostconditionAnnotation(qualifier = MinLen.class)
- * {@literal @}Target({ElementType.METHOD, ElementType.CONSTRUCTOR})
+ * {@literal @}PostconditionAnnotation(qualifier = MinLen.class)
+ * {@literal @}Target({ElementType.METHOD, ElementType.CONSTRUCTOR})
* public {@literal @}interface EnsuresMinLen {
* String[] value();
* {@literal @}QualifierArgument("value")
@@ -47,7 +47,7 @@
* {@code @MinLen(2)} upon return.
*
*
- * {@literal @}EnsuresMinLen(value = "field", targetValue = 2")
+ * {@literal @}EnsuresMinLen(value = "field", targetValue = 2)
* public void setField(String argument) {
* field = "(" + argument + ")";
* }
diff --git a/src/java.base/share/classes/org/checkerframework/framework/qual/PreconditionAnnotation.java b/src/java.base/share/classes/org/checkerframework/framework/qual/PreconditionAnnotation.java
index 542b1fa13b4..a71dac79d1b 100644
--- a/src/java.base/share/classes/org/checkerframework/framework/qual/PreconditionAnnotation.java
+++ b/src/java.base/share/classes/org/checkerframework/framework/qual/PreconditionAnnotation.java
@@ -27,12 +27,12 @@
* org.checkerframework.common.value.qual.MinLen} qualifier:
*
*
- * {@literal @}PreconditionAnnotation(qualifier = MinLen.class)
- * {@literal @}Target({ElementType.METHOD, ElementType.CONSTRUCTOR})
- * public {@literal @}interface RequiresMinLen {
- * String[] value();
- * {@literal @}QualifierArgument("value")
- * int targetValue() default 0;
+ * {@literal @}PreconditionAnnotation(qualifier = MinLen.class)
+ * {@literal @}Target({ElementType.METHOD, ElementType.CONSTRUCTOR})
+ * public {@literal @}interface RequiresMinLen {
+ * String[] value();
+ * {@literal @}QualifierArgument("value")
+ * int targetValue() default 0;
*
*
* The {@code value} element holds the expressions to which the qualifier applies and {@code
@@ -43,10 +43,10 @@
* {@code @MinLen(2)} upon entry.
*
*
- * {@literal @}RequiresMinLen(value = "field", targetValue = 2")
- * public char getThirdCharacter() {
- * return field.charAt(2);
- * }
+ * {@literal @}RequiresMinLen(value = "field", targetValue = 2")
+ * public char getThirdCharacter() {
+ * return field.charAt(2);
+ * }
*
*
* @see RequiresQualifier