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

Aleksei Efimov aefimov at openjdk.org
Tue Jul 2 15:19:25 UTC 2024


On Fri, 28 Jun 2024 10:44:05 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.
>
> Nizar Benalla has updated the pull request incrementally with one additional commit since the last revision:
> 
>   Improve package description based on  Efimov's suggestion

Package descriptions generated from new `package-info.java` files look good and have the same content as the ones generated from `package.html` files.  A minor issue - two leftover tags need to be removed:

src/java.naming/share/classes/javax/naming/event/package-info.java line 60:

> 58:  * An application, for example, can register its interest in changes to
> 59:  * objects in a context as follows:
> 60:  * <blockquote>

The leftover `<blockquote>` can be removed:
Suggestion:

src/java.naming/share/classes/javax/naming/event/package-info.java line 76:

> 74:  * }
> 75:  * }
> 76:  * </blockquote>

The leftover `</blockquote>` can be removed:

Suggestion:

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

Changes requested by aefimov (Reviewer).

PR Review: https://git.openjdk.org/jdk/pull/19529#pullrequestreview-2154146953
PR Review Comment: https://git.openjdk.org/jdk/pull/19529#discussion_r1662721260
PR Review Comment: https://git.openjdk.org/jdk/pull/19529#discussion_r1662721369


More information about the core-libs-dev mailing list