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

Andy Goryachev angorya at openjdk.org
Wed Jun 21 18:57:09 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.

Looking good.
I guess we don't change the copyright year because we don't change the actual content?
Or should it be changed?

right, got my diff panels swapped.

so all the non-whitespace diffs have newfound link, we are good!

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

Marked as reviewed by angorya (Reviewer).

PR Review: https://git.openjdk.org/jfx/pull/1159#pullrequestreview-1491489377
PR Comment: https://git.openjdk.org/jfx/pull/1159#issuecomment-1601408205


More information about the openjfx-dev mailing list