RFR: 8287333: Clean up ParamTaglet and ThrowsTaglet [v4]

Jonathan Gibbons jjg at openjdk.java.net
Tue Jun 7 06:17:16 UTC 2022


On Mon, 6 Jun 2022 23:31:19 GMT, Pavel Rappo <prappo at openjdk.org> wrote:

>> src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/ParamTaglet.java line 70:
>> 
>>> 68:      */
>>> 69:     private static Map<String, String> mapNameToPosition(Utils utils, List<? extends Element> params) {
>>> 70:         Map<String, String> result = new HashMap<>();
>> 
>> Is there a reason not to change this to `Map<String, Integer>`
>
> We could change it to `Integer` now, but it wouldn't help us much: the `DocFinder.Input.tagId` field, which that `Integer` is ultimately compared against, is of type `String`. To make it all the way, we would need to change `tagId` to `Integer` too. But that won't work because `tagId` is also used by `ThrowsTaglet` to store an exception class (or an exception type variable) name.
> 
> That said, I agree that we should change `String` to `Integer` there. Let's just not do it now as it requires deeper refactoring; I have a plan already and some implementation in the works.

Noted about tagId. You could still do a local cleanup for the type of the map, but I guess we'll wait and see what your plan is.

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

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


More information about the javadoc-dev mailing list