spring-projects / spring-projects/spring-boot

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

Open
#40,562 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type: enhancement
Dominant language
Java
Stars
81.5k
Forks
42.7k
Avg merge
2d 4h
Merged PRs (30d)
65

Description

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading JEP 467 and the spring-boot-configuration-processor implementation to identify where documentation comments are parsed. Check whether the JavaDoc API changes have been finalized before proceeding; the issue is done when the processor supports the finalized Markdown comment representation and its affected behavior is verified.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.