Integrated: 8331879: Clean up non-standard use of /// comments in `java.base`

[Jonathan Gibbons]

On Tue, 7 May 2024 22:23:48 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:

> With the advent of JEP 467, `///` comments may be treated as documentation comments, and may be subject to the recently new `javac` warning about "dangling doc comments" in unexpected places.
> 
> In keeping with the policy to keep the `java.base` module free of all `javac` warnings, this patch proposes edits to existing uses of `///`.
> 
> There are two dominant policies in the proposed changes. 
> 1. A long horizontal line of `/////` is replaced by `//-----`
> 2. A long vertical series of lines beginning `///` is replaced by lines beginning `//|`.
> 
> As with all style changes, I have also tried to honor local usage, for consistency.
> 
> In one place, a pair of comments appeared to contain directives (`CLOVER:ON`, `CLOVER:OFF`).  I investigated the use of such comments to determine that the exact form of the comment prefix was not significant. (Phew!)
> 
> 
> (This PR is informally blocked by JEP 467).

This pull request has now been integrated.

Changeset: 10eb1cb6
Author:    Jonathan Gibbons <jjg at openjdk.org>
URL:       https://git.openjdk.org/jdk/commit/10eb1cb639095caa2636cc87c45201d4f8cf1eb4
Stats:     117 lines in 25 files changed: 0 ins; 0 del; 117 mod

8331879: Clean up non-standard use of /// comments in `java.base`

Reviewed-by: naoto, iris, darcy

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

PR: https://git.openjdk.org/jdk/pull/19130