RFR: 8338525: Leading and trailing code blocks by indentation [v3]

Hannes Wallnöfer hannesw at openjdk.org
Tue Sep 24 07:48:38 UTC 2024


On Mon, 23 Sep 2024 18:55:11 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:

>> Please review these changes to correct the handling of leading and trailing indented code blocks in a doc comment.
>> 
>> There are two separate issues here: one for leading indented code blocks and one for trailing indented code blocks.
>> 
>> 1. Leading indented code blocks: the code to detect the first sentence of a doc comment is modified to detect whether the comment begins with an indented code block. If it does, the first sentence is deemed to be empty, and the body of the doc comment begins with the code block.
>> 2. Trailing indented code blocks: the content of the indented code block is marked as significant by updating `lastNonWhite`, which will cause the content to be recorded (not dropped) if the code block is followed by EOF.
>> 
>> For both cases, simple `DocTree` AST-level tests are provided, as well as full `JavadocTester` tests, that test the end-user view of the generated docs.
>
> Jonathan Gibbons has updated the pull request incrementally with one additional commit since the last revision:
> 
>   fix typo, reported in review comment

Marked as reviewed by hannesw (Reviewer).

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

PR Review: https://git.openjdk.org/jdk/pull/20956#pullrequestreview-2324360600


More information about the compiler-dev mailing list