RFR: 8338525: Leading and trailing code blocks by indentation

Jonathan Gibbons jjg at openjdk.org
Thu Sep 12 22:46:19 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.

Updated: in Markdown mode, `DocCommentParser` needs to determine and handle the "kind" of line for the first line as well as after newlines.

The tests are extended to include the specific test case given in the JBS entry.

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

PR Comment: https://git.openjdk.org/jdk/pull/20956#issuecomment-2347364871


More information about the compiler-dev mailing list