RFR: 8330178: Clean up non-standard use of /** comments in `java.base` [v2]
Naoto Sato
naoto at openjdk.org
Fri Apr 19 19:51:06 UTC 2024
On Fri, 19 Apr 2024 19:21:13 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:
>> Please review a set of updates to clean up use of `/**` comments in the vicinity of declarations.
>>
>> There are various categories of update:
>>
>> * "Box comments" beginning with `/**`
>> * Misplaced doc comments before package or import statements
>> * Misplaced doc comments after the annotations for a declaration
>> * Dangling `/**` comments relating to a group of declarations, separate from the doc comments for each of those declarations
>> * Use of `/**` for the legal header at or near the top of the file
>>
>> In one case, two doc comments before a declaration were merged, which fixes a bug/omission in the documented serialized form.
>
> Jonathan Gibbons has updated the pull request incrementally with one additional commit since the last revision:
>
> Update src/java.base/share/classes/sun/net/www/protocol/file/FileURLConnection.java
>
> Fix grammatical typo
>
> Co-authored-by: Alexey Ivanov <alexey.ivanov at oracle.com>
Unless it is absolutely necessary, I would not fix comments in `jdk.internal.icu` sources, as they are in the upstream code, and would like to minimize the merging effort.
-------------
PR Comment: https://git.openjdk.org/jdk/pull/18846#issuecomment-2067190364
More information about the core-libs-dev
mailing list