Add language hints to getDisplayName() and getDescription()

openrewrite · Dec 23, 2024 · 216c0c1 · 216c0c1
1 parent a2ab406
commit 216c0c1
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/main/java/org/openrewrite/java/template/processor/RefasterTemplateProcessor.java b/src/main/java/org/openrewrite/java/template/processor/RefasterTemplateProcessor.java
@@ -298,7 +298,7 @@ private void writeRecipeClass(JCTree.JCClassDecl classDecl, boolean outerClassRe
                             out.write("@Generated(\"" + GENERATOR_NAME + "\")\n");
                             out.write("public class " + outerClassName + " extends Recipe {\n");
                             out.write("    /**\n");
-                            out.write("     * Instantiates a new instance.\n");
+                            out.write("     * Instantiates a new instance.\n"); // For -Xdoclint
                             out.write("     */\n");
                             out.write("    public " + outerClassName + "() {}\n\n");
                             out.write(recipeDescriptor(classDecl,
@@ -545,11 +545,13 @@ private String recipeDescriptor(JCTree.JCClassDecl classDecl, String defaultDisp
 
                 String recipeDescriptor = "    @Override\n" +
                                           "    public String getDisplayName() {\n" +
+                                          "        //language=markdown\n" +
                                           "        return \"" + displayName + "\";\n" +
                                           "    }\n" +
                                           "\n" +
                                           "    @Override\n" +
                                           "    public String getDescription() {\n" +
+                                          "        //language=markdown\n" +
                                           "        return \"" + description + "\";\n" +
                                           "    }\n" +
                                           "\n";