Integrated: JDK-8258602: JavaDoc field summary does not indicate final modifier
Hannes Wallnöfer
hannesw at openjdk.java.net
Fri Apr 30 09:50:54 UTC 2021
On Tue, 27 Apr 2021 09:45:05 GMT, Hannes Wallnöfer <hannesw at 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.
This pull request has now been integrated.
Changeset: 07ecd421
Author: Hannes Wallnöfer <hannesw at openjdk.org>
URL: https://git.openjdk.java.net/jdk/commit/07ecd421d1538ae53ffbea65eccfa938e19a9f0f
Stats: 174 lines in 8 files changed: 159 ins; 0 del; 15 mod
8258602: JavaDoc field summary does not indicate final modifier
Reviewed-by: jjg
-------------
PR: https://git.openjdk.java.net/jdk/pull/3716
More information about the javadoc-dev
mailing list