RFR: JDK-8298405: Support Markdown in Documentation Comments [v22]
Pavel Rappo
prappo at openjdk.org
Thu Feb 8 16:33:14 UTC 2024
On Wed, 8 Nov 2023 17:17:46 GMT, Pavel Rappo <prappo at openjdk.org> wrote:
>> Jonathan Gibbons has updated the pull request with a new target base due to a merge or a rebase. The pull request now contains 28 commits:
>>
>> - Merge remote-tracking branch 'upstream/master' into 8298405.doclet-markdown-v3 # Please enter a commit message to explain why this merge is necessary, # especially if it
>> merges an updated upstream into a topic branch. # # Lines starting with '#' will be ignored, and an empty message aborts # the commit.
>> - add test case contributed by @lahodaj
>> - initial fix for source offset problem
>> - remove unused imports
>> - First pass at remove DocCommentTransformer from the public API.
>>
>> It is still declared internally, and installed by default, using the service-provider mechanism.
>> If the standard impl is not available, an identity transformer is used.
>> - updates for "first sentence" issues and tests
>> - add info about provenance of `jdk.internal.md` module
>> - MarkdownTransformer: tweak doc comments
>> - MarkdownTransformer: change `Lower.replaceIter` to be `private final`
>> - MarkdownTransformer: use suggested text for using streams
>> - ... and 18 more: https://git.openjdk.org/jdk/compare/18e24d06...63dd8bf4
>
> test/langtools/jdk/javadoc/tool/sampleapi/lib/sampleapi/generator/ModuleGenerator.java line 49:
>
>> 47: import sampleapi.util.PoorDocCommentTable;
>> 48:
>> 49: import static com.sun.tools.javac.parser.Tokens.Comment.CommentStyle.JAVADOC;
>
> To clarify, the change to this file is that you removed two unused imports, right?
Ping. Maybe if it is not essential, we could remove that change, to keep PR more focused.
-------------
PR Review Comment: https://git.openjdk.org/jdk/pull/16388#discussion_r1483182361
More information about the compiler-dev
mailing list