RFR: 8287333: Clean up ParamTaglet and ThrowsTaglet [v4]
Pavel Rappo
prappo at openjdk.java.net
Mon Jun 6 23:38:12 UTC 2022
On Mon, 6 Jun 2022 20:24:08 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:
>> Pavel Rappo has updated the pull request with a new target base due to a merge or a rebase. The pull request now contains 33 commits:
>>
>> - Merge branch 'master' into 8287333
>>
>> This resolves a conflict in ParamTaglet.
>> - Clean up if-branch
>> - Remove upper-bounded wildcard
>>
>> This change simplifies code without any disadvantages:
>>
>> * Those `List<? extends XTree>` are read-only
>> * An argument of the `List<XTree>` type can still be passed to a `List<? extends XTree>` parameter
>> - Simplify inheritThrowsDocumentation
>> - Reuse more specific variable
>> - Merge branch 'master' into 8287333
>> - Incremental update
>>
>> - Renames local variables and method parameters
>> - Improves comments
>> - Removes debug leftovers
>> - Update top-level doc comment
>> - Trivially re-order assignments
>>
>> ...for re-use
>> - Reformat for clarity
>>
>> Now it's very clear that the "Throws:" section consists of three types of exceptions:
>>
>> 1. documented
>> 2. inherited
>> 3. undocumented
>> - ... and 23 more: https://git.openjdk.java.net/jdk/compare/ebc012ec...6bbe871b
>
> src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/ParamTaglet.java line 177:
>
>> 175: Content result = writer.getOutputInstance();
>> 176: Input input = new DocFinder.Input(writer.configuration().utils, holder, this,
>> 177: Integer.toString(position), kind == ParamKind.TYPE_PARAMETER);
>
> Inconsistent w.r.t line 76 ... `String.valueOf` vs `Integer.toString`
Huh? 02021a27 changed all `String.valueOf` to `Integer.toString` for consistency.
-------------
PR: https://git.openjdk.java.net/jdk/pull/8886
More information about the javadoc-dev
mailing list