RFR: 8332072: Convert package.html files in `java.naming` to package-info.java

Joe Darcy darcy at openjdk.org
Mon Jun 3 21:32:33 UTC 2024


On Mon, 3 Jun 2024 17:26:52 GMT, Nizar Benalla <nbenalla at openjdk.org> wrote:

> Can I please get a review for this small change? The motivation is that javac does not recognize `package.html` files.
> 
> The conversion was simple, I used a script to rename the files, append "*" on the left and remove some HTML tags like `<body>` and `<html>`. I did the conversion in place, renaming them in git but with the big amount of change `git` thinks it's a new file.
> 
> I also added a new `package-info.java` file to `javax.naming.ldap.spi`. I hope that's fine.

I recommend having the new package-info.java files follow the now-current javadoc conventions including:

* Using `{@code foo}` in preference to `<code>foo</code>`
* Using the `@snippet` tag in preference to `<blockquore><pre>`
* etc.

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

PR Comment: https://git.openjdk.org/jdk/pull/19529#issuecomment-2146157205


More information about the core-libs-dev mailing list