8340082: Use inline return tag in java.base

jddarcy · jddarcy · commit 89c172ac47a9 · 2024-09-13T16:49:28.000Z
Reviewed-by: iris, prappo, lancea, djelinski, naoto, liach
diff --git a/src/java.base/share/classes/java/io/ObjectInputFilter.java b/src/java.base/share/classes/java/io/ObjectInputFilter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016, 2022, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -1218,8 +1218,7 @@ private static boolean matchesPackage(Class<?> c, String pkg) {
             }
 
             /**
-             * Returns the pattern used to create this filter.
-             * @return the pattern used to create this filter
+             * {@return the pattern used to create this filter}
              */
             @Override
             public String toString() {
diff --git a/src/java.base/share/classes/java/io/ObjectInputStream.java b/src/java.base/share/classes/java/io/ObjectInputStream.java
@@ -3859,8 +3859,7 @@ private int readUTFChar(StringBuilder sbuf, long utflen)
         }
 
         /**
-         * Returns the number of bytes read from the input stream.
-         * @return the number of bytes read from the input stream
+         * {@return the number of bytes read from the input stream}
          */
         long getBytesRead() {
             return in.getBytesRead();
diff --git a/src/java.base/share/classes/java/lang/annotation/Retention.java b/src/java.base/share/classes/java/lang/annotation/Retention.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2003, 2020, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2003, 2024, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -45,8 +45,7 @@
 @Target(ElementType.ANNOTATION_TYPE)
 public @interface Retention {
     /**
-     * Returns the retention policy.
-     * @return the retention policy
+     * {@return the retention policy}
      */
     RetentionPolicy value();
 }
diff --git a/src/java.base/share/classes/java/nio/charset/MalformedInputException.java b/src/java.base/share/classes/java/nio/charset/MalformedInputException.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2000, 2021, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2000, 2024, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -56,16 +56,14 @@ public MalformedInputException(int inputLength) {
     }
 
     /**
-     * Returns the length of the input.
-     * @return the length of the input
+     * {@return the length of the input}
      */
     public int getInputLength() {
         return inputLength;
     }
 
     /**
-     * Returns the message.
-     * @return the message
+     * {@return the message}
      */
     public String getMessage() {
         return "Input length = " + inputLength;
diff --git a/src/java.base/share/classes/java/nio/charset/UnmappableCharacterException.java b/src/java.base/share/classes/java/nio/charset/UnmappableCharacterException.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2001, 2021, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2001, 2024, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -56,16 +56,14 @@ public UnmappableCharacterException(int inputLength) {
     }
 
     /**
-     * Returns the length of the input.
-     * @return the length of the input
+     * {@return the length of the input}
      */
     public int getInputLength() {
         return inputLength;
     }
 
     /**
-     * Returns the message.
-     * @return the message
+     * {@return the message}
      */
     public String getMessage() {
         return "Input length = " + inputLength;
diff --git a/src/java.base/share/classes/java/time/format/TextStyle.java b/src/java.base/share/classes/java/time/format/TextStyle.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2012, 2024, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -137,8 +137,7 @@ public boolean isStandalone() {
     }
 
     /**
-     * Returns the stand-alone style with the same size.
-     * @return the stand-alone style with the same size
+     * {@return the stand-alone style with the same size}
      */
     public TextStyle asStandalone() {
         return TextStyle.values()[ordinal()  | 1];
diff --git a/src/java.base/share/classes/java/util/concurrent/SynchronousQueue.java b/src/java.base/share/classes/java/util/concurrent/SynchronousQueue.java
@@ -477,8 +477,7 @@ public Spliterator<E> spliterator() {
     }
 
     /**
-     * Returns a zero-length array.
-     * @return a zero-length array
+     * {@return a zero-length array}
      */
     public Object[] toArray() {
         return new Object[0];
diff --git a/src/java.base/share/classes/java/util/concurrent/atomic/AtomicBoolean.java b/src/java.base/share/classes/java/util/concurrent/atomic/AtomicBoolean.java
@@ -176,8 +176,7 @@ public final boolean getAndSet(boolean newValue) {
     }
 
     /**
-     * Returns the String representation of the current value.
-     * @return the String representation of the current value
+     * {@return the String representation of the current value}
      */
     public String toString() {
         return Boolean.toString(get());
diff --git a/src/java.base/share/classes/java/util/concurrent/atomic/AtomicInteger.java b/src/java.base/share/classes/java/util/concurrent/atomic/AtomicInteger.java
@@ -340,8 +340,7 @@ public final int accumulateAndGet(int x,
     }
 
     /**
-     * Returns the String representation of the current value.
-     * @return the String representation of the current value
+     * {@return the String representation of the current value}
      */
     public String toString() {
         return Integer.toString(get());
diff --git a/src/java.base/share/classes/java/util/concurrent/atomic/AtomicIntegerArray.java b/src/java.base/share/classes/java/util/concurrent/atomic/AtomicIntegerArray.java
@@ -366,8 +366,7 @@ public final int accumulateAndGet(int i, int x,
     }
 
     /**
-     * Returns the String representation of the current values of array.
-     * @return the String representation of the current values of array
+     * {@return the String representation of the current values of array}
      */
     public String toString() {
         int iMax = array.length - 1;
diff --git a/src/java.base/share/classes/java/util/concurrent/atomic/AtomicLong.java b/src/java.base/share/classes/java/util/concurrent/atomic/AtomicLong.java
@@ -341,8 +341,7 @@ public final long accumulateAndGet(long x,
     }
 
     /**
-     * Returns the String representation of the current value.
-     * @return the String representation of the current value
+     * {@return the String representation of the current value}
      */
     public String toString() {
         return Long.toString(get());
diff --git a/src/java.base/share/classes/java/util/concurrent/atomic/AtomicLongArray.java b/src/java.base/share/classes/java/util/concurrent/atomic/AtomicLongArray.java
@@ -366,8 +366,7 @@ public final long accumulateAndGet(int i, long x,
     }
 
     /**
-     * Returns the String representation of the current values of array.
-     * @return the String representation of the current values of array
+     * {@return the String representation of the current values of array}
      */
     public String toString() {
         int iMax = array.length - 1;
diff --git a/src/java.base/share/classes/java/util/concurrent/atomic/AtomicReference.java b/src/java.base/share/classes/java/util/concurrent/atomic/AtomicReference.java
@@ -269,8 +269,7 @@ public final V accumulateAndGet(V x,
     }
 
     /**
-     * Returns the String representation of the current value.
-     * @return the String representation of the current value
+     * {@return the String representation of the current value}
      */
     public String toString() {
         return String.valueOf(get());
diff --git a/src/java.base/share/classes/java/util/concurrent/atomic/AtomicReferenceArray.java b/src/java.base/share/classes/java/util/concurrent/atomic/AtomicReferenceArray.java
@@ -297,8 +297,7 @@ public final E accumulateAndGet(int i, E x,
     }
 
     /**
-     * Returns the String representation of the current values of array.
-     * @return the String representation of the current values of array
+     * {@return the String representation of the current values of array}
      */
     public String toString() {
         int iMax = array.length - 1;
diff --git a/src/java.base/share/classes/java/util/concurrent/atomic/DoubleAccumulator.java b/src/java.base/share/classes/java/util/concurrent/atomic/DoubleAccumulator.java
@@ -189,8 +189,7 @@ public double getThenReset() {
     }
 
     /**
-     * Returns the String representation of the current value.
-     * @return the String representation of the current value
+     * {@return the String representation of the current value}
      */
     public String toString() {
         return Double.toString(get());
diff --git a/src/java.base/share/classes/java/util/concurrent/atomic/LongAccumulator.java b/src/java.base/share/classes/java/util/concurrent/atomic/LongAccumulator.java
@@ -183,8 +183,7 @@ public long getThenReset() {
     }
 
     /**
-     * Returns the String representation of the current value.
-     * @return the String representation of the current value
+     * {@return the String representation of the current value}
      */
     public String toString() {
         return Long.toString(get());
diff --git a/src/java.base/share/classes/java/util/jar/Manifest.java b/src/java.base/share/classes/java/util/jar/Manifest.java
@@ -119,8 +119,7 @@ public Manifest(Manifest man) {
     }
 
     /**
-     * Returns the main Attributes for the Manifest.
-     * @return the main Attributes for the Manifest
+     * {@return the main Attributes for the Manifest}
      */
     public Attributes getMainAttributes() {
         return attr;
diff --git a/src/java.base/share/classes/java/util/zip/Deflater.java b/src/java.base/share/classes/java/util/zip/Deflater.java
@@ -782,8 +782,7 @@ public int deflate(ByteBuffer output, int flush) {
     }
 
     /**
-     * Returns the ADLER-32 value of the uncompressed data.
-     * @return the ADLER-32 value of the uncompressed data
+     * {@return the ADLER-32 value of the uncompressed data}
      */
     public int getAdler() {
         synchronized (zsRef) {
diff --git a/src/java.base/share/classes/java/util/zip/Inflater.java b/src/java.base/share/classes/java/util/zip/Inflater.java
@@ -282,8 +282,7 @@ public boolean needsInput() {
     }
 
     /**
-     * Returns true if a preset dictionary is needed for decompression.
-     * @return true if a preset dictionary is needed for decompression
+     * {@return true if a preset dictionary is needed for decompression}
      * @see Inflater#setDictionary
      */
     public boolean needsDictionary() {
@@ -293,10 +292,8 @@ public boolean needsDictionary() {
     }
 
     /**
-     * Returns true if the end of the compressed data stream has been
-     * reached.
-     * @return true if the end of the compressed data stream has been
-     * reached
+     * {@return true if the end of the compressed data stream has been
+     * reached}
      */
     public boolean finished() {
         synchronized (zsRef) {
@@ -602,8 +599,7 @@ public int inflate(ByteBuffer output) throws DataFormatException {
     }
 
     /**
-     * Returns the ADLER-32 value of the uncompressed data.
-     * @return the ADLER-32 value of the uncompressed data
+     * {@return the ADLER-32 value of the uncompressed data}
      */
     public int getAdler() {
         synchronized (zsRef) {
diff --git a/src/java.base/share/classes/java/util/zip/ZipEntry.java b/src/java.base/share/classes/java/util/zip/ZipEntry.java
@@ -138,8 +138,7 @@ public ZipEntry(ZipEntry e) {
     }
 
     /**
-     * Returns the name of the entry.
-     * @return the name of the entry
+     * {@return the name of the entry}
      */
     public String getName() {
         return name;
diff --git a/src/java.base/share/classes/java/util/zip/ZipFile.java b/src/java.base/share/classes/java/util/zip/ZipFile.java
@@ -498,8 +498,7 @@ public int available() throws IOException {
     }
 
     /**
-     * Returns the path name of the ZIP file.
-     * @return the path name of the ZIP file
+     * {@return the path name of the ZIP file}
      */
     public String getName() {
         return filePath;
@@ -560,8 +559,7 @@ public Iterator<T> asIterator() {
     }
 
     /**
-     * Returns an enumeration of the ZIP file entries.
-     * @return an enumeration of the ZIP file entries
+     * {@return an enumeration of the ZIP file entries}
      * @throws IllegalStateException if the ZIP file has been closed
      */
     public Enumeration<? extends ZipEntry> entries() {

Original file line number	Diff line number	Diff line change
`@@ -3859,8 +3859,7 @@ private int readUTFChar(StringBuilder sbuf, long utflen)`
`3859`	`3859`	`}`
`3860`	`3860`
`3861`	`3861`	`/**`
`3862`		`- * Returns the number of bytes read from the input stream.`
`3863`		`- * @return the number of bytes read from the input stream`
	`3862`	`+ * {@return the number of bytes read from the input stream}`
`3864`	`3863`	`*/`
`3865`	`3864`	`long getBytesRead() {`
`3866`	`3865`	`return in.getBytesRead();`
Original file line number	Diff line number	Diff line change
`@@ -477,8 +477,7 @@ public Spliterator<E> spliterator() {`
`477`	`477`	`}`
`478`	`478`
`479`	`479`	`/**`
`480`		`- * Returns a zero-length array.`
`481`		`- * @return a zero-length array`
	`480`	`+ * {@return a zero-length array}`
`482`	`481`	`*/`
`483`	`482`	`public Object[] toArray() {`
`484`	`483`	`return new Object[0];`
Original file line number	Diff line number	Diff line change
`@@ -176,8 +176,7 @@ public final boolean getAndSet(boolean newValue) {`
`176`	`176`	`}`
`177`	`177`
`178`	`178`	`/**`
`179`		`- * Returns the String representation of the current value.`
`180`		`- * @return the String representation of the current value`
	`179`	`+ * {@return the String representation of the current value}`
`181`	`180`	`*/`
`182`	`181`	`public String toString() {`
`183`	`182`	`return Boolean.toString(get());`
Original file line number	Diff line number	Diff line change
`@@ -340,8 +340,7 @@ public final int accumulateAndGet(int x,`
`340`	`340`	`}`
`341`	`341`
`342`	`342`	`/**`
`343`		`- * Returns the String representation of the current value.`
`344`		`- * @return the String representation of the current value`
	`343`	`+ * {@return the String representation of the current value}`
`345`	`344`	`*/`
`346`	`345`	`public String toString() {`
`347`	`346`	`return Integer.toString(get());`
Original file line number	Diff line number	Diff line change
`@@ -366,8 +366,7 @@ public final int accumulateAndGet(int i, int x,`
`366`	`366`	`}`
`367`	`367`
`368`	`368`	`/**`
`369`		`- * Returns the String representation of the current values of array.`
`370`		`- * @return the String representation of the current values of array`
	`369`	`+ * {@return the String representation of the current values of array}`
`371`	`370`	`*/`
`372`	`371`	`public String toString() {`
`373`	`372`	`int iMax = array.length - 1;`