Moderne licensed

Convert Javadoc to Markdown documentation comments

Recipe IDorg.openrewrite.java.migrate.lang.JavadocToMarkdownDocComment

Artifactorg.openrewrite.recipe:rewrite-migrate-java

Convert traditional Javadoc comments (/** ... */) to Markdown documentation comments (///) as supported by JEP 467 in Java 23+. Transforms HTML constructs like <pre>, <code>, <em>, <p>, and lists to their Markdown equivalents, and converts inline tags like {@code} and {@link} to Markdown syntax.

Single recipeMSAL

Usage

This recipe has no required configuration options. You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.java.migrate.lang.JavadocToMarkdownDocComment

If the recipe isn’t available locally, install it with:

mod config recipes jar install org.openrewrite.recipe:rewrite-migrate-java:3.41.0

Data tables

Structured output this recipe can produce.

Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats