search

spring-projects / spring-boot

Spring Boot
https://spring.io/projects/spring-boot
Apache License 2.0
73.62k stars 40.32k forks source link

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

Open wilkinsona opened 2 months ago

wilkinsona commented 2 months ago

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 commented 1 month ago

We may need to consider https://github.com/spring-projects/spring-boot/issues/11698 as part of this.

mhalbritter commented 4 weeks ago

https://openjdk.org/jeps/467 will land in Java 23.