RFR: 8180066: Convert package.html files to package-info.java

Kevin Rushforth kcr at openjdk.org
Wed Jun 21 18:57:12 UTC 2023


On Wed, 21 Jun 2023 15:05:47 GMT, Kevin Rushforth <kcr at openjdk.org> wrote:

> This is a doc cleanup task to convert all `package.html` files to `package-info.java`, which is the recommended way to provide package documentation.
> 
> The first commit is the result of running a shell script that @jonathan-gibbons provided. The second commit removes an errant `<h2>` tag from the `package-info.java` for one package, `javafx.util.converter` that is unneeded and unwanted. That same file also had a redundant first sentence, which was coincidentally removed by the tool, so once I removed the `<h2>` tag the docs for that package now looks good and matches the other packages. There are no other changes in the javadoc-generated API docs.
> 
> One thing I didn't do is add a ` *` at the beginning of the lines that are now part of a javadoc-style comment block. This minimizes the diffs, but it means we won't be using the usual pattern for those comment blocks. I'm inclined to file a follow-up issue rather than changing that now.

Unfortunately, with all of the whitespace diffs, it's now hard to see the actual changes. It might be worth looking at the diffs from the first two commits, and then separately confirming that the third commit is just whitespace changes.

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

PR Comment: https://git.openjdk.org/jfx/pull/1159#issuecomment-1601405789


More information about the openjfx-dev mailing list