RFR: 8280713: Related to comment inheritance jdk.javadoc cleanup and refactoring

[Jonathan Gibbons]

On Wed, 26 Jan 2022 16:20:30 GMT, Pavel Rappo <prappo at openjdk.org> wrote:

> Explorative refactoring performed while looking into multiple `@inheritDoc` issues. The easiest way to review it is to, probably, go commit by commit; they are quite focused and commented. Not only the branch as a whole, but all the constituent commits should pass tests and leave JDK API Documentation unchanged.

Commit: Clarify comments for overriddenType

Ok, but ... grumble ... I disagree with downgrading the comments. I know they were not good comments to begin with, but IMO it would be better to fix them than to downgrade them. Even important internal API deserves good comments.

That being said, "form follows function", and it is more important for the information to be correct than pretty. :-)

Commit: Further clarify comments for overriddenType

OK

Commit: Further clarify comments for isSimpleOverride

OK.

Commit: Fix a typo (automatically)

OK

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

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