RFR: JDK-8312445: Array types in annotation elements show square brackets twice
Hannes Wallnöfer
hannesw at openjdk.org
Wed Jul 26 09:11:20 UTC 2023
On Tue, 25 Jul 2023 15:32:22 GMT, Pavel Rappo <prappo at openjdk.org> wrote:
>> Please review a change to fix the representation of array types as values of annotation elements in javadoc-generated documentation.
>>
>> The primary fix is to avoid generating duplicate `[]` brackets for array types, but there are a few secondary improvements:
>>
>> - When linking to a type, only use the type name as link label, appending the `.class` as plain text after the link
>> - Support linking to the base type of array types, again appending the square brackets and `.class` after the link
>> - Leave it to the `LinkFactory` code to decide whether to use the qualified or simple type name for a link (uses `isLinkable` instead of `isIncluded`)
>>
>> There already was some test code for the use of array types in annotation elements in `TestNewLanguageFeatures.java`, but it was disabled with a comment referring to another issue that has long been resolved.
>
>> * When linking to a type, only use the type name as link label, appending the `.class` as plain text after the link
>
> This is how it's done by some IDE code editors whilst you hover over a class literal, which is probably okay.
Thanks for the review @pavelrappo, feedback is addressed in a new commit.
-------------
PR Comment: https://git.openjdk.org/jdk/pull/15019#issuecomment-1651295816
More information about the javadoc-dev
mailing list