Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support Markdown documentation comments in spring-boot-configuration-processor #40562

Open
wilkinsona opened this issue Apr 29, 2024 · 0 comments
Labels
status: blocked An issue that's blocked on an external project change type: enhancement A general enhancement
Milestone

Comments

@wilkinsona
Copy link
Member

wilkinsona commented Apr 29, 2024

https://openjdk.org/jeps/467, currently targeted at Java 23, will add support for writing documentation comments using Markdown. The JEP describes some additions to the API that may affect our annotation processor:

We introduce a new type of tree node, RawTextTree, which contains uninterpreted text, together with a new tree-node kind, DocTree.Kind.MARKDOWN, which indicates Markdown content in a RawTextTree. We add corresponding new visitRawText methods to DocTreeVisitor and its subtypes, DocTreeScanner and DocTreePathScanner.

While some exploratory work may be worthwhile, this is largely blocked until the changes to JavaDoc have been finalised.

@wilkinsona wilkinsona added type: enhancement A general enhancement status: blocked An issue that's blocked on an external project change labels Apr 29, 2024
@wilkinsona wilkinsona added this to the 3.x milestone Apr 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: blocked An issue that's blocked on an external project change type: enhancement A general enhancement
Projects
None yet
Development

No branches or pull requests

1 participant