Converting existing package.html files to package-info.java

[Alan Bateman]

On 15/05/2024 09:16, Magnus Ihse Bursie wrote:
>
> On 2024-05-15 02:13, Nizar Benalla wrote:
>
>> Hello,
>>
>> I discovered after some recent work around javadoc that `javac` does 
>> not recognize `package.html` files, which predate 
>> `package-info.java`. Some tools that want to analyze doc comments 
>> need to deal with this in special ways.
>>
>> Maybe optional support for these files can be added into `javac`. But 
>> with only 21 `package.html` files in the JDK in modules that do not 
>> have internal in the name, I want to suggest simply converting them 
>> as it will be done once and won't need maintenance
>>
>> There are 9 package.html files I'd like to convert into 
>> package-info.java in java.management, one in java.management.rmi (and 
>> if this passes, one in java.naming)
>>
>> I want to hear what you think,
>> Nizar
>>
> That sounds like a straightforward and beneficial conversion. As you 
> say, the package.html format is old, and provides no benefits to 
> package-info.java.
>
>
I agree. There was an effort a few years ago to replace html package 
descriptions with package-info.java but it seems that a few of them 
weren't done at the time.

-Alan
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mail.openjdk.org/pipermail/serviceability-dev/attachments/20240515/57ed19f7/attachment-0001.htm>