RFR: 8341907: javac -Xlint should ignore /// on first line of source file [v3]

[Jonathan Gibbons]

On Fri, 8 Nov 2024 12:23:22 GMT, Pavel Rappo <prappo at openjdk.org> wrote:

>> Please review this PR to exempt the [trick that JBang uses][] from the "dangling comment" lint introduced in JDK 23. For more information see this PR's JBS issue and its comment section.
>> 
>> The fix makes sure that the warning is not issued if it relates to a leading `///` comment. For simplicity and similarity with the shebang construct, the comment should start from the first character of the file, and not a more permissive first non-whitespace character of the file.
>> 
>> Since I'm not an expert in `java.compiler`, I'm unsure if my code intercepts warning in the most appropriate layer. Please double-check that.
>> 
>> Skimming through the tests which I used for inspiration, `test/langtools/tools/javac/danglingDocComments`, I was unsure why they compile itself first without any `/ref=` construct. The test I introduced here does not do this; am I missing something?
>> 
>> [trick that JBang uses]: https://www.jbang.dev/documentation/guide/latest/usage.html
>
> Pavel Rappo has updated the pull request incrementally with two additional commits since the last revision:
> 
>  - Fix a pre-existing doc typo
>  - Make the check more specific

Marked as reviewed by jjg (Reviewer).

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

PR Review: https://git.openjdk.org/jdk/pull/21923#pullrequestreview-2424386640