RFR: 8310667: Normalize comment blocks in newly-converted package-info.java files

Andy Goryachev angorya at openjdk.org
Fri Jun 23 00:08:09 UTC 2023


On Thu, 22 Jun 2023 18:38:43 GMT, Kevin Rushforth <kcr at openjdk.org> wrote:

> This is a follow-up fix for [JDK-8180066](https://bugs.openjdk.org/browse/JDK-8180066). As mentioned in the description of PR #1159, we should normalize the javadoc comment blocks in the `package-info.java` files, which were converted from `package.html`.
> 
> In addition to being good cleanup, it also resolves a CI test failure that was introduced by [JDK-8180066](https://bugs.openjdk.org/browse/JDK-8180066), and is being tracked by [JDK-8310654](https://bugs.openjdk.org/browse/JDK-8310654).
> 
> The generated API docs are identical before and after this fix, excluding white-space changes. So the following show zero differences:
> 
> 
> $ diff -w -r before/build/javadoc after/build/javadoc
> 
> 
> Additionally, the following now passes, whereas it fails without this fix:
> 
> 
> $ gradle :graphics:test

Marked as reviewed by angorya (Reviewer).

There are still whitespace diffs (leading whitespace, see the screenshot), but i think it's ok for all practical purposes.

<img width="1530" alt="Screenshot 2023-06-22 at 17 03 47" src="https://github.com/openjdk/jfx/assets/107069028/5dfa0380-750e-4173-82d7-9c592c16786f">

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

PR Review: https://git.openjdk.org/jfx/pull/1160#pullrequestreview-1494148655
PR Comment: https://git.openjdk.org/jfx/pull/1160#issuecomment-1603457021


More information about the openjfx-dev mailing list