Integrated: 8338525: Leading and trailing code blocks by indentation

Jonathan Gibbons jjg at openjdk.org
Tue Sep 24 20:12:42 UTC 2024


On Wed, 11 Sep 2024 22:36:02 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.

This pull request has now been integrated.

Changeset: 0b8c9f6d
Author:    Jonathan Gibbons <jjg at openjdk.org>
URL:       https://git.openjdk.org/jdk/commit/0b8c9f6d2397dcb480dc5ae109607d86f2b15619
Stats:     214 lines in 5 files changed: 190 ins; 17 del; 7 mod

8338525: Leading and trailing code blocks by indentation

Reviewed-by: hannesw, prappo

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

PR: https://git.openjdk.org/jdk/pull/20956


More information about the compiler-dev mailing list