RFR: JDK-8267204: Expose access to underlying streams in Reporter [v2]

[Jonathan Gibbons]

On Fri, 4 Jun 2021 20:30:30 GMT, Pavel Rappo <prappo at openjdk.org> wrote:

>> Jonathan Gibbons has updated the pull request with a new target base due to a merge or a rebase. The pull request now contains 17 commits:
>> 
>>  - Update copyright years
>>  - Merge remote-tracking branch 'upstream/master' into jdk-8267204-reporter
>>  - Merge remote-tracking branch 'upstream/master' into jdk-8267204-reporter
>>  - Fix typos
>>  - Fix typos
>>  - Fix typos
>>  - Merge remote-tracking branch 'upstream/master' into jdk-8267204-reporter
>>  - Address review feedback
>>  - Address review feedback
>>  - extend Messages to provide convenient access to the new Reporter.report method
>>  - ... and 7 more: https://git.openjdk.java.net/jdk/compare/20b63127...78e811b1
>
> src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/Messages.java line 141:
> 
>> 139:      *
>> 140:      * @param e    an element identifying the declaration whose position should
>> 141:      *             be included with the message
> 
> I see what you've changed: one of these words needed to go. Either "should" or "to". You chose "to". Unless you did it for semantical reasons, I note that this file uses "to be" in the vast majority of similar cases.

The wording is correct, but I agree it the overall phrasing is inconsistent in form with similar phrases elsewhere, because in this context it uses "the declaration whose position ..."

It's an internal API, so I don't want to get too hung up on it.   I'll change the form to be more like the others.

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

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