RFR: 8340082: Use inline return tag in java.base

Fri Sep 13 07:32:14 UTC 2024

On Fri, 13 Sep 2024 02:47:18 GMT, Joe Darcy <darcy at openjdk.org> wrote:

> Candidates for this refactoring were found programmatically; the program to find candidates is in a comment on the bug.

The old version of the doc comments had a `.` at the end of the first sentence:

src/java.base/share/classes/java/io/ObjectInputFilter.java line 1221:

> 1219: 
> 1220:             /**
> 1221:              * {@return the pattern used to create this filter}

Suggestion:

             * {@return the pattern used to create this filter}.

src/java.base/share/classes/java/io/ObjectInputStream.java line 3862:

> 3860: 
> 3861:         /**
> 3862:          * {@return the number of bytes read from the input stream}

Suggestion:

         * {@return the number of bytes read from the input stream}.

src/java.base/share/classes/java/lang/annotation/Retention.java line 48:

> 46: public @interface Retention {
> 47:     /**
> 48:      * {@return the retention policy}

Suggestion:

     * {@return the retention policy}.

src/java.base/share/classes/java/nio/charset/MalformedInputException.java line 59:

> 57: 
> 58:     /**
> 59:      * {@return the length of the input}

Suggestion:

     * {@return the length of the input}.

src/java.base/share/classes/java/nio/charset/MalformedInputException.java line 66:

> 64: 
> 65:     /**
> 66:      * {@return the message}

Suggestion:

     * {@return the message}.

src/java.base/share/classes/java/nio/charset/UnmappableCharacterException.java line 59:

> 57: 
> 58:     /**
> 59:      * {@return the length of the input}

Suggestion:

     * {@return the length of the input}.

src/java.base/share/classes/java/nio/charset/UnmappableCharacterException.java line 66:

> 64: 
> 65:     /**
> 66:      * {@return the message}

Suggestion:

     * {@return the message}.

src/java.base/share/classes/java/time/format/TextStyle.java line 140:

> 138: 
> 139:     /**
> 140:      * {@return the stand-alone style with the same size}

Suggestion:

     * {@return the stand-alone style with the same size}.

src/java.base/share/classes/java/util/concurrent/SynchronousQueue.java line 480:

> 478: 
> 479:     /**
> 480:      * {@return a zero-length array}

Suggestion:

     * {@return a zero-length array}.

src/java.base/share/classes/java/util/concurrent/atomic/AtomicBoolean.java line 179:

> 177: 
> 178:     /**
> 179:      * {@return the String representation of the current value}

Suggestion:

     * {@return the String representation of the current value}.

src/java.base/share/classes/java/util/concurrent/atomic/AtomicInteger.java line 343:

> 341: 
> 342:     /**
> 343:      * {@return the String representation of the current value}

Suggestion:

     * {@return the String representation of the current value}.

src/java.base/share/classes/java/util/concurrent/atomic/AtomicIntegerArray.java line 369:

> 367: 
> 368:     /**
> 369:      * {@return the String representation of the current values of array}

Suggestion:

     * {@return the String representation of the current values of array}.

src/java.base/share/classes/java/util/concurrent/atomic/AtomicLong.java line 344:

> 342: 
> 343:     /**
> 344:      * {@return the String representation of the current value}

Suggestion:

     * {@return the String representation of the current value}.

src/java.base/share/classes/java/util/concurrent/atomic/AtomicLongArray.java line 369:

> 367: 
> 368:     /**
> 369:      * {@return the String representation of the current values of array}

Suggestion:

     * {@return the String representation of the current values of array}.

src/java.base/share/classes/java/util/concurrent/atomic/AtomicReference.java line 272:

> 270: 
> 271:     /**
> 272:      * {@return the String representation of the current value}

Suggestion:

     * {@return the String representation of the current value}.

src/java.base/share/classes/java/util/concurrent/atomic/AtomicReferenceArray.java line 300:

> 298: 
> 299:     /**
> 300:      * {@return the String representation of the current values of array}

Suggestion:

     * {@return the String representation of the current values of array}.

src/java.base/share/classes/java/util/concurrent/atomic/DoubleAccumulator.java line 192:

> 190: 
> 191:     /**
> 192:      * {@return the String representation of the current value}

Suggestion:

     * {@return the String representation of the current value}.

src/java.base/share/classes/java/util/concurrent/atomic/LongAccumulator.java line 186:

> 184: 
> 185:     /**
> 186:      * {@return the String representation of the current value}

Suggestion:

     * {@return the String representation of the current value}.

src/java.base/share/classes/java/util/jar/Manifest.java line 122:

> 120: 
> 121:     /**
> 122:      * {@return the main Attributes for the Manifest}

Suggestion:

     * {@return the main Attributes for the Manifest}.

src/java.base/share/classes/java/util/zip/Deflater.java line 785:

> 783: 
> 784:     /**
> 785:      * {@return the ADLER-32 value of the uncompressed data}

Suggestion:

     * {@return the ADLER-32 value of the uncompressed data}.

src/java.base/share/classes/java/util/zip/Inflater.java line 285:

> 283: 
> 284:     /**
> 285:      * {@return true if a preset dictionary is needed for decompression}

Suggestion:

     * {@return true if a preset dictionary is needed for decompression}.

src/java.base/share/classes/java/util/zip/Inflater.java line 296:

> 294:     /**
> 295:      * {@return true if the end of the compressed data stream has been
> 296:      * reached}

Suggestion:

     * {@return true if the end of the compressed data stream has been
     * reached}.

src/java.base/share/classes/java/util/zip/Inflater.java line 602:

> 600: 
> 601:     /**
> 602:      * {@return the ADLER-32 value of the uncompressed data}

Suggestion:

     * {@return the ADLER-32 value of the uncompressed data}.

src/java.base/share/classes/java/util/zip/ZipEntry.java line 141:

> 139: 
> 140:     /**
> 141:      * {@return the name of the entry}

Suggestion:

     * {@return the name of the entry}.

src/java.base/share/classes/java/util/zip/ZipFile.java line 501:

> 499: 
> 500:     /**
> 501:      * {@return the path name of the ZIP file}

Suggestion:

     * {@return the path name of the ZIP file}.

src/java.base/share/classes/java/util/zip/ZipFile.java line 562:

> 560: 
> 561:     /**
> 562:      * {@return an enumeration of the ZIP file entries}

Suggestion:

     * {@return an enumeration of the ZIP file entries}.

-------------

PR Review: https://git.openjdk.org/jdk/pull/20981#pullrequestreview-2302321414
PR Review Comment: https://git.openjdk.org/jdk/pull/20981#discussion_r1758326174
PR Review Comment: https://git.openjdk.org/jdk/pull/20981#discussion_r1758326396
PR Review Comment: https://git.openjdk.org/jdk/pull/20981#discussion_r1758326761
PR Review Comment: https://git.openjdk.org/jdk/pull/20981#discussion_r1758327147
PR Review Comment: https://git.openjdk.org/jdk/pull/20981#discussion_r1758327483
PR Review Comment: https://git.openjdk.org/jdk/pull/20981#discussion_r1758327766
PR Review Comment: https://git.openjdk.org/jdk/pull/20981#discussion_r1758327939
PR Review Comment: https://git.openjdk.org/jdk/pull/20981#discussion_r1758328188
PR Review Comment: https://git.openjdk.org/jdk/pull/20981#discussion_r1758328373
PR Review Comment: https://git.openjdk.org/jdk/pull/20981#discussion_r1758328561
PR Review Comment: https://git.openjdk.org/jdk/pull/20981#discussion_r1758328660
PR Review Comment: https://git.openjdk.org/jdk/pull/20981#discussion_r1758328760
PR Review Comment: https://git.openjdk.org/jdk/pull/20981#discussion_r1758328833
PR Review Comment: https://git.openjdk.org/jdk/pull/20981#discussion_r1758328935
PR Review Comment: https://git.openjdk.org/jdk/pull/20981#discussion_r1758329031
PR Review Comment: https://git.openjdk.org/jdk/pull/20981#discussion_r1758329171
PR Review Comment: https://git.openjdk.org/jdk/pull/20981#discussion_r1758329268
PR Review Comment: https://git.openjdk.org/jdk/pull/20981#discussion_r1758329376
PR Review Comment: https://git.openjdk.org/jdk/pull/20981#discussion_r1758329468
PR Review Comment: https://git.openjdk.org/jdk/pull/20981#discussion_r1758329520
PR Review Comment: https://git.openjdk.org/jdk/pull/20981#discussion_r1758329601
PR Review Comment: https://git.openjdk.org/jdk/pull/20981#discussion_r1758329771
PR Review Comment: https://git.openjdk.org/jdk/pull/20981#discussion_r1758329873
PR Review Comment: https://git.openjdk.org/jdk/pull/20981#discussion_r1758330051
PR Review Comment: https://git.openjdk.org/jdk/pull/20981#discussion_r1758330157
PR Review Comment: https://git.openjdk.org/jdk/pull/20981#discussion_r1758330290