On Wed, 19 Apr 2023 15:34:59 GMT, Jonathan Gibbons <[email protected]> wrote:
>> src/jdk.compiler/share/classes/com/sun/tools/javac/parser/DocCommentParser.java
>> line 82:
>>
>>> 80: /** The initial part of an HTML file up to and including the
>>> {@code body} and possible {@code <main>} tag. */
>>> 81: PREAMBLE,
>>> 82: /** The initial part of a doc comment, or the rich-text content
>>> of a block tag. */
>>
>> Curious: is "initial part of a doc comment" the same as what we now call
>> [main
>> description](https://docs.oracle.com/en/java/javase/20/docs/specs/javadoc/doc-comment-spec.html#main-description)?
>
> Yes, will change, for clarification and to better distinguish it from the
> description for PREAMBLE
Or no. As a phase, it is the part between the PREAMBLE and POSTAMBLE. It is
when reading the main description, and rich-text content of block tags, in both
cases excluding the content of inline tags, which are read with INLINE phase.
I'll definitely have to work on this text.
-------------
PR Review Comment: https://git.openjdk.org/jdk/pull/13431#discussion_r1171536298
