On Tue, 27 Apr 2021 10:29:05 GMT, Hannes Wallnöfer <hann...@openjdk.org> wrote:

>> I found that adding the `final` modifier does not add too much visual noise 
>> to the documentation. I didn't find any occurrence where there were more 
>> than two modifiers on a member summary (usually either `static final` or 
>> `protected final`). 
>> 
>> On the other hand, I do think the `final` modifier adds important 
>> information about the member. Although this is more true for fields than for 
>> other members, for reasons of consistency I decided to show it for all kinds 
>> of members except for those where it is not allowed (such as for enums).
>> 
>> To my surprise I also noticed that there weren't any test cases for field 
>> summaries, so I added a new test.
>
> Hannes Wallnöfer has refreshed the contents of this pull request, and 
> previous commits have been removed. The incremental views will show 
> differences compared to the previous content of the PR. The pull request 
> contains one new commit since the last revision:
> 
>   JDK-8258602: JavaDoc field summary does not indicate final modifier

Hi Hannes, out of curiosity - for a final class, will all members (or none) 
appear final in the generated documentation? Or will it depend on whether a 
redundant `final` keyword appears in the code or not? From your code changes, I 
guess it will be the latter - which makes me wonder whether we want to go that 
far in the API documentation.

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

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

Reply via email to