On Tue, 9 Feb 2021 02:08:45 GMT, Jonathan Gibbons <j...@openjdk.org> wrote:

>> This is a cleanup of the javadoc link generating code.
>> 
>> There is a simple "horizontal" component to this change that removes the 
>> `strong` parameters from most `HtmlDocletWriter#getDocLink` methods which 
>> where the value used was always `false`, and related changes in all the code 
>> using these methods. 
>> 
>> The slightly more complex part of this change are changes in 
>> `LinkInfo[Impl]` and `LinkFactory[Impl]`. Here the target was to reduce the 
>> number of booean fields in `LinkInfo` and their interaction with the code, 
>> which was quite hard to grasp. I managed to replace several fields 
>> controlling generation of type parameter links with a single 
>> `includeTypeParameterLinks()` method. The use of this method and the 
>> remaining boolean fields in the code is quite straightforward. 
>> 
>> I also removed some bits of dead code and simplified the control flow a bit 
>> by trying to do things only in one place and one way when possible.
>> 
>> The code passes all javadoc tests and generates documentation identical to 
>> the old code.
>
> I see that `isStrong` is still used, but eventually maps into a style of 
> `typeNameLink` down in the `Links` class, line 188. I believe the name 
> `strong` refers back to using the HTML `<strong>` element, which no longer 
> exists. 
> 
> Can we now or soon change the name or at least the doc comments for this 
> parameter into something more meaningful?

Updated review to Approved, but I hope we can do something now or soon to clean 
up the remaining use of `isStrong`. Either eliminate it or rename to something 
more appropriate.

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

PR: https://git.openjdk.java.net/jdk/pull/2437

Reply via email to