RFR: 8336679: Add @implSpec for the default implementations in Process.waitFor() [v3]

ExE Boss duke at openjdk.org
Wed Jul 24 07:54:38 UTC 2024


On Tue, 23 Jul 2024 20:58:01 GMT, Naoto Sato <naoto at openjdk.org> wrote:

>> This is a simple doc-only change that follows up [JDK-8336479](https://bugs.openjdk.org/browse/JDK-8336479). A corresponding CSR has also been drafted.
>
> Naoto Sato has updated the pull request incrementally with one additional commit since the last revision:
> 
>   apiNote -> implNote

Maybe add an empty line between `@implSpec` and `@implNote`:

src/java.base/share/classes/java/lang/Process.java line 450:

> 448:      * @implNote
> 449:      * Concrete implementations of this class are strongly encouraged to
> 450:      * override this method with a more efficient implementation.

Suggestion:

     * @implSpec
     * The default implementation of this method polls the {@code exitValue}
     * to check if the process has terminated.
     *
     * @implNote
     * Concrete implementations of this class are strongly encouraged to
     * override this method with a more efficient implementation.

src/java.base/share/classes/java/lang/Process.java line 496:

> 494:      * @implNote
> 495:      * Concrete implementations of this class are strongly encouraged to
> 496:      * override this method with a more efficient implementation.

Suggestion:

     * @implSpec
     * The default implementation of this method polls the {@code exitValue}
     * to check if the process has terminated.
     *
     * @implNote
     * Concrete implementations of this class are strongly encouraged to
     * override this method with a more efficient implementation.

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

PR Review: https://git.openjdk.org/jdk/pull/20285#pullrequestreview-2195902793
PR Review Comment: https://git.openjdk.org/jdk/pull/20285#discussion_r1689310654
PR Review Comment: https://git.openjdk.org/jdk/pull/20285#discussion_r1689310914


More information about the core-libs-dev mailing list