Skip to content

Commit c27f651

Browse files
mernstmernst
authored
Don't use /// comments, whose content must be Markdown in Java 23
1 parent cb70fb7 commit c27f651

File tree

46 files changed

+250
-250
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+250
-250
lines changed

‎checker-util/src/main/java/org/checkerframework/checker/regex/util/RegexUtil.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -426,9 +426,9 @@ public static boolean noStringMatchesAnyRegex(
426426
return true;
427427
}
428428

429-
///
430-
/// Utilities
431-
///
429+
//
430+
// Utilities
431+
//
432432

433433
// This is from CollectionsPlume, but is here to make the file self-contained.
434434

‎checker/build.gradle

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -370,9 +370,9 @@ if (skipDelombok) {
370370
tasks.test.dependsOn('delombok')
371371
}
372372

373-
///
374-
/// Tests of the -Ainfer command-line argument. These are not whole-program inference tests.
375-
///
373+
//
374+
// Tests of the -Ainfer command-line argument. These are not whole-program inference tests.
375+
//
376376

377377
test {
378378
useJUnit {
@@ -884,9 +884,9 @@ task ainferTest(group: 'Verification') {
884884
dependsOn('ainferResourceLeakAjavaTest')
885885
}
886886

887-
///
888-
/// Whole-program inference tests
889-
///
887+
//
888+
// Whole-program inference tests
889+
//
890890

891891
// This is run as part of the inferenceTests task.
892892
task wpiManyTest(group: 'Verification') {

‎checker/jtreg/nullness/defaultsPersist/ReferenceInfoUtil.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public static List<TypeAnnotation> extendedAnnotationsOf(
3939
return annos;
4040
}
4141

42-
/////////////////// Extract type annotations //////////////////
42+
// /////////////////// Extract type annotations //////////////////
4343
private void findAnnotations(ClassFile cf, List<TypeAnnotation> annos) {
4444
findAnnotations(cf, Attribute.RuntimeVisibleTypeAnnotations, annos);
4545
findAnnotations(cf, Attribute.RuntimeInvisibleTypeAnnotations, annos);
@@ -130,7 +130,7 @@ private static void findAnnotations(
130130
}
131131
}
132132

133-
/////////////////////// Equality testing /////////////////////
133+
// /////////////////////// Equality testing /////////////////////
134134
private static boolean areEquals(int a, int b) {
135135
return a == b || a == IGNORE_VALUE || b == IGNORE_VALUE;
136136
}

‎checker/jtreg/nullness/inheritDeclAnnoPersist/ReferenceInfoUtil.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ public static List<Annotation> extendedAnnotationsOf(ClassFile cf) {
2323
return annos;
2424
}
2525

26-
/////////////////// Extract annotations //////////////////
26+
// /////////////////// Extract annotations //////////////////
2727
private static void findAnnotations(ClassFile cf, List<Annotation> annos) {
2828
for (Method m : cf.methods) {
2929
findAnnotations(cf, m, Attribute.RuntimeVisibleAnnotations, annos);

‎checker/src/main/java/org/checkerframework/checker/i18nformatter/I18nFormatterVisitor.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -159,9 +159,9 @@ protected boolean commonAssignmentCheck(
159159
}
160160
}
161161

162-
/// TODO: What does "take precedence over" mean? Both are issued, but the
163-
/// "i18nformat.excess.arguments" appears first in the output. Is this meant to not call
164-
/// super.commonAssignmentCheck() if `result` is already false?
162+
// TODO: What does "take precedence over" mean? Both are issued, but the
163+
// "i18nformat.excess.arguments" appears first in the output. Is this meant to not call
164+
// super.commonAssignmentCheck() if `result` is already false?
165165
// By calling super.commonAssignmentCheck() last, any "i18nformat.excess.arguments"
166166
// message issued for a given line of code will take precedence over the "assignment"
167167
// issued by super.commonAssignmentCheck().

‎checker/src/main/java/org/checkerframework/checker/index/samelen/SameLenAnnotatedTypeFactory.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -361,9 +361,9 @@ public List<String> getSameLensFromString(
361361
return AnnotationUtils.getElementValueArray(sameLenAnno, sameLenValueElement, String.class);
362362
}
363363

364-
///
365-
/// Creating @SameLen annotations
366-
///
364+
//
365+
// Creating @SameLen annotations
366+
//
367367

368368
/**
369369
* Creates a @SameLen annotation whose values are the given strings.

‎checker/src/main/java/org/checkerframework/checker/interning/com-sun.astub

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ public class Repository {
3333
}
3434

3535

36-
///////////////////////////////////////////////////////////////////////////
37-
/// public static final @Interned String (initialized to constant)
38-
///
36+
// ///////////////////////////////////////////////////////////////////////////
37+
// public static final @Interned String (initialized to constant)
38+
//
3939

4040
package com.sun.imageio.plugins.gif;
4141
public class GIFStreamMetadata {

‎checker/tests/calledmethods-usevaluechecker/GenerateDataKeyRequestExamples.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ void setTwice4(AWSKMS client) {
101101
client.generateDataKey(request);
102102
}
103103

104-
/// Interprocedural
104+
// Interprocedural
105105

106106
void callee2(
107107
AWSKMS client,

‎checker/tests/nonempty/IndexOfNonNegative.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,7 @@ public boolean removeAll(Collection<?> c) {
7171
@Override
7272
public void clear() {}
7373

74-
///////////////////////////////////////////////////////////////////////////
75-
74+
// ///////////////////////////////////////////////////////////////////////////
7675
// iterators
7776

7877
@Override

‎checker/tests/nonempty/SizeInIsEmpty.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public boolean isEmpty3() {
3939
return size() == 0;
4040
}
4141

42-
//// iterators
42+
// iterators
4343

4444
@Override
4545
public @PolyNonEmpty Iterator<E> iterator(@PolyNonEmpty SizeInIsEmpty<E> this) {

‎checker/tests/nullness/AssertIfFalseTest2.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ public static void usePriorityQueue(PriorityQueue1<@NonNull Object> active) {
99
}
1010
}
1111

12-
///////////////////////////////////////////////////////////////////////////
13-
/// Classes copied from the annotated JDK
14-
///
12+
// ///////////////////////////////////////////////////////////////////////////
13+
// Classes copied from the annotated JDK
14+
//
1515

1616
public class PriorityQueue1<E extends @NonNull Object> {
1717
@EnsuresNonNullIf(

‎checker/tests/nullness/EnsuresNonNullIfTest.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ public static void fromDirNeg(File1 dbdir) {
2121
}
2222
}
2323

24-
///////////////////////////////////////////////////////////////////////////
25-
/// Classes copied from the annotated JDK
26-
///
24+
// ///////////////////////////////////////////////////////////////////////////
25+
// Classes copied from the annotated JDK
26+
//
2727

2828
// NOTE: These annotations are actually incorrect (& not in the JDK).
2929
// But, the test remains valid in how it exercises nullness checking.

‎checker/tests/nullness/JavaExpressionParsingBug.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
public abstract class JavaExpressionParsingBug {
66

7-
//// Check that JavaExpressions with explicit and implicit 'this' work
7+
// Check that JavaExpressions with explicit and implicit 'this' work
88

99
protected @Nullable JMenuBar menuBar = null;
1010

@@ -14,7 +14,7 @@ public void addFavorite() {}
1414
@RequiresNonNull("this.menuBar")
1515
public void addFavorite1() {}
1616

17-
//// Check JavaExpressions for static fields with different ways to access the field
17+
// Check JavaExpressions for static fields with different ways to access the field
1818

1919
static @Nullable String i = null;
2020

‎checker/tests/nullness/NNOEStaticFields.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,9 +79,9 @@ void test4() {
7979
@NonNull Object f = System.out;
8080
}
8181

82-
///////////////////////////////////////////////////////////////////////////
83-
/// Copied from Daikon's ChicoryPremain
84-
///
82+
// ///////////////////////////////////////////////////////////////////////////
83+
// Copied from Daikon's ChicoryPremain
84+
//
8585

8686
static class ChicoryPremain1 {
8787

‎checker/tests/nullness/NonEmptyCollection.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ public class NonEmptyCollection {
2626
return sm.firstKey();
2727
}
2828

29-
///////////////////////////////////////////////////////////////////////////
30-
/// Helper classes copied from JDK
31-
///
29+
// ///////////////////////////////////////////////////////////////////////////
30+
// Helper classes copied from JDK
31+
//
3232

3333
public class PriorityQueue1<E> {
3434
@SuppressWarnings("purity") // object creation is forbidden in pure methods

‎checker/tests/nullness/ScopingConstruct.java

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -198,9 +198,9 @@ ScopingConstruct.Inner.InnerInner sciii() {
198198
throw new Error("not implemented");
199199
}
200200

201-
///
202-
/// Formal parameters
203-
///
201+
//
202+
// Formal parameters
203+
//
204204

205205
void fsn(StaticNested sn) {}
206206

@@ -247,9 +247,9 @@ void fscsnni(ScopingConstruct.StaticNested.NestedInner scsnni) {}
247247

248248
void fscsnnni(ScopingConstruct.StaticNested.@Nullable NestedInner scsnnni) {}
249249

250-
///
251-
/// Local variables
252-
///
250+
//
251+
// Local variables
252+
//
253253

254254
void lvsn() {
255255
StaticNested sn;
@@ -334,9 +334,9 @@ void lvscsnnni() {
334334
ScopingConstruct.StaticNested.@Nullable NestedInner scsnnni;
335335
}
336336

337-
///
338-
/// Resource variables
339-
///
337+
//
338+
// Resource variables
339+
//
340340

341341
void rvsn() {
342342
try (StaticNested sn = null) {}
@@ -421,9 +421,9 @@ void rvscsnnni() {
421421
try (ScopingConstruct.StaticNested.@Nullable NestedInner scsnnni = null) {}
422422
}
423423

424-
///
425-
/// For variables
426-
///
424+
//
425+
// For variables
426+
//
427427

428428
void fvsn() {
429429
for (StaticNested sn = null; ; ) {}

‎checker/tests/resourceleak/ACSocketTest.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -183,9 +183,9 @@ Socket createSocket(boolean b, String address, int port) throws IOException {
183183

184184
// @EnsuresCalledMethodsIf(expression = "#1", methods = {"close"}, result = true)
185185
// void closeSocket(Socket sock) {
186-
//// if (sock == null) {
187-
//// return;
188-
//// }
186+
// // if (sock == null) {
187+
// // return;
188+
// // }
189189
//
190190
// try {
191191
// sock.close();

‎checker/tests/signature/ClassGetNameBinaryName.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ class TestGetName {
2727
// :: error: (assignment)
2828
@DotSeparatedIdentifiers String s13 = Inner.class.getName();
2929

30-
/// Primitive types
30+
// Primitive types
3131

3232
@PrimitiveType String prim1 = int.class.getName();
3333

@@ -45,7 +45,7 @@ class TestGetName {
4545
// :: error: (assignment)
4646
@PrimitiveType String prim6 = void.class.getName();
4747

48-
/// Arrays
48+
// Arrays
4949

5050
// :: error: (assignment)
5151
@DotSeparatedIdentifiers String s6 = int[].class.getName();
@@ -82,7 +82,7 @@ class TestGetCanonicalName {
8282
// :: error: (assignment)
8383
@CanonicalNameAndBinaryName String s13 = Inner.class.getName();
8484

85-
/// Primitive types
85+
// Primitive types
8686

8787
@PrimitiveType String prim1 = int.class.getCanonicalName();
8888

@@ -100,7 +100,7 @@ class TestGetCanonicalName {
100100
// :: error: (assignment)
101101
@PrimitiveType String prim6 = void.class.getCanonicalName();
102102

103-
/// Arrays
103+
// Arrays
104104

105105
// :: error: (assignment)
106106
@CanonicalNameAndBinaryName String s6 = int[].class.getCanonicalName();

‎checker/tests/signedness/DefaultsSignedness.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ public void SignedTest(
118118
119119
sinBoxedByte = testBoxedByte;
120120
121-
//// :: error: (assignment)
121+
// // :: error: (assignment)
122122
conBoxedByte = testBoxedByte;
123123
124124
// Test boxed shorts
@@ -127,7 +127,7 @@ public void SignedTest(
127127
128128
sinBoxedShort = testBoxedShort;
129129
130-
//// :: error: (assignment)
130+
// // :: error: (assignment)
131131
conBoxedShort = testBoxedShort;
132132
133133
// Test boxed Integers
@@ -136,7 +136,7 @@ public void SignedTest(
136136
137137
sinBoxedInteger = testBoxedInteger;
138138
139-
//// :: error: (assignment)
139+
// // :: error: (assignment)
140140
conBoxedInteger = testBoxedInteger;
141141
142142
// Test boxed Longs
@@ -145,7 +145,7 @@ public void SignedTest(
145145
146146
sinBoxedLong = testBoxedLong;
147147
148-
//// :: error: (assignment)
148+
// // :: error: (assignment)
149149
conBoxedLong = testBoxedLong;
150150
*/
151151
}

‎dataflow/src/main/java/org/checkerframework/dataflow/expression/JavaExpression.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -325,9 +325,9 @@ public String toStringDebug() {
325325
return String.format("%s(%s): %s", getClass().getSimpleName(), type, toString());
326326
}
327327

328-
///
329-
/// Static methods
330-
///
328+
//
329+
// Static methods
330+
//
331331

332332
/**
333333
* Returns the Java expression for a {@link FieldAccessNode}. The result may contain {@link
@@ -712,9 +712,9 @@ public static List<FormalParameter> getFormalParameters(ExecutableElement method
712712
return parameters;
713713
}
714714

715-
///
716-
/// Obtaining the receiver
717-
///
715+
//
716+
// Obtaining the receiver
717+
//
718718

719719
/**
720720
* Returns the receiver of the given invocation.

‎dataflow/src/main/java/org/checkerframework/dataflow/expression/ValueLiteral.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ public boolean containsModifiableAliasOf(Store<?> store, JavaExpression other) {
135135
return false; // not modifiable
136136
}
137137

138-
/// java.lang.Object methods
138+
// java.lang.Object methods
139139

140140
@Override
141141
public boolean equals(@Nullable Object obj) {

‎docs/examples/errorprone/build.gradle

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
///////////////////////////////////////////////////////////////////////////
2-
/// Checker Framework pluggable type-checking and Error Prone example
3-
///
1+
// ///////////////////////////////////////////////////////////////////////////
2+
// Checker Framework pluggable type-checking and Error Prone example
3+
//
44

55
plugins {
66
id 'java'

‎docs/examples/lombok/build.gradle

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
///////////////////////////////////////////////////////////////////////////
2-
/// Checker Framework pluggable type-checking and Lombok example
3-
///
1+
// ///////////////////////////////////////////////////////////////////////////
2+
// Checker Framework pluggable type-checking and Lombok example
3+
//
44

55
plugins {
66
id 'java'

0 commit comments

Comments
 (0)