Fix comment validation errors when Eclipse starts up (#2684)

* Fix comment validation errors when Eclipse starts up

- fix TokenScanner to add markdown comment token for
  isComment() method
- fix CodeTemplateContextType.isValidComment() to set up a Scanner
  with JDK 23 so markdown comment templates will be properly
  parsed
- add missing JavadocQuickFixTest25 to test suite
- fixes #2679

Author: jjohnstn

org.eclipse.jdt.core.manipulation/common/org/eclipse/jdt/internal/core/manipulation/CodeTemplateContextType.java

@@ -248,38 +248,38 @@ public CodeTemplateContextType(String contextName) {
 			addResolver(new CodeTemplateVariableResolver(TYPENAME,  JavaManipulationMessages.CodeTemplateContextType_variable_description_typename));
 			addCompilationUnitVariables();
 			break;
-		case TYPECOMMENT_CONTEXTTYPE:
 		case MARKDOWNTYPECOMMENT_CONTEXTTYPE:
+		case TYPECOMMENT_CONTEXTTYPE:
 			addResolver(new CodeTemplateVariableResolver(TYPENAME,  JavaManipulationMessages.CodeTemplateContextType_variable_description_typename));
 			addResolver(new CodeTemplateVariableResolver(ENCLOSING_TYPE,  JavaManipulationMessages.CodeTemplateContextType_variable_description_enclosingtype));
 			addResolver(new TagsVariableResolver());
 			addCompilationUnitVariables();
 			fIsComment= true;
 			break;
-		case FILECOMMENT_CONTEXTTYPE:
 		case MARKDOWNFILECOMMENT_CONTEXTTYPE:
+		case FILECOMMENT_CONTEXTTYPE:
 			addResolver(new CodeTemplateVariableResolver(TYPENAME,  JavaManipulationMessages.CodeTemplateContextType_variable_description_typename));
 			addCompilationUnitVariables();
 			fIsComment= true;
 			break;
-		case FIELDCOMMENT_CONTEXTTYPE:
 		case MARKDOWNFIELDCOMMENT_CONTEXTTYPE:
+		case FIELDCOMMENT_CONTEXTTYPE:
 			addResolver(new CodeTemplateVariableResolver(FIELD_TYPE, JavaManipulationMessages.CodeTemplateContextType_variable_description_fieldtype));
 			addResolver(new CodeTemplateVariableResolver(FIELD, JavaManipulationMessages.CodeTemplateContextType_variable_description_fieldname));
 			addCompilationUnitVariables();
 			fIsComment= true;
 			break;
-		case METHODCOMMENT_CONTEXTTYPE:
 		case MARKDOWNMETHODCOMMENT_CONTEXTTYPE:
+		case METHODCOMMENT_CONTEXTTYPE:
 			addResolver(new CodeTemplateVariableResolver(ENCLOSING_TYPE,  JavaManipulationMessages.CodeTemplateContextType_variable_description_enclosingtype));
 			addResolver(new CodeTemplateVariableResolver(ENCLOSING_METHOD,  JavaManipulationMessages.CodeTemplateContextType_variable_description_enclosingmethod));
 			addResolver(new CodeTemplateVariableResolver(RETURN_TYPE,  JavaManipulationMessages.CodeTemplateContextType_variable_description_returntype));
 			addResolver(new TagsVariableResolver());
 			addCompilationUnitVariables();
 			fIsComment= true;
 			break;
-		case MODULECOMMENT_CONTEXTTYPE:
 		case MARKDOWNMODULECOMMENT_CONTEXTTYPE:
+		case MODULECOMMENT_CONTEXTTYPE:
 			addResolver(new CodeTemplateVariableResolver(ENCLOSING_MODULE, JavaManipulationMessages.CodeTemplateContextType_variable_description_enclosingmodule));
 			addResolver(new TagsVariableResolver());
 			addCompilationUnitVariables();
@@ -293,24 +293,24 @@ public CodeTemplateContextType(String contextName) {
 			addCompilationUnitVariables();
 			fIsComment= true;
 			break;
-		case DELEGATECOMMENT_CONTEXTTYPE:
 		case MARKDOWNDELEGATECOMMENT_CONTEXTTYPE:
+		case DELEGATECOMMENT_CONTEXTTYPE:
 			addResolver(new CodeTemplateVariableResolver(ENCLOSING_TYPE,  JavaManipulationMessages.CodeTemplateContextType_variable_description_enclosingtype));
 			addResolver(new CodeTemplateVariableResolver(ENCLOSING_METHOD,  JavaManipulationMessages.CodeTemplateContextType_variable_description_enclosingmethod));
 			addResolver(new CodeTemplateVariableResolver(SEE_TO_TARGET_TAG,  JavaManipulationMessages.CodeTemplateContextType_variable_description_see_target_tag));
 			addResolver(new TagsVariableResolver());
 			addCompilationUnitVariables();
 			fIsComment= true;
 			break;
-		case CONSTRUCTORCOMMENT_CONTEXTTYPE:
 		case MARKDOWNCONSTRUCTORCOMMENT_CONTEXTTYPE:
+		case CONSTRUCTORCOMMENT_CONTEXTTYPE:
 			addResolver(new CodeTemplateVariableResolver(ENCLOSING_TYPE,  JavaManipulationMessages.CodeTemplateContextType_variable_description_enclosingtype));
 			addResolver(new TagsVariableResolver());
 			addCompilationUnitVariables();
 			fIsComment= true;
 			break;
-		case GETTERCOMMENT_CONTEXTTYPE:
 		case MARKDOWNGETTERCOMMENT_CONTEXTTYPE:
+		case GETTERCOMMENT_CONTEXTTYPE:
 			addResolver(new CodeTemplateVariableResolver(ENCLOSING_TYPE,  JavaManipulationMessages.CodeTemplateContextType_variable_description_enclosingtype));
 			addResolver(new CodeTemplateVariableResolver(FIELD_TYPE,  JavaManipulationMessages.CodeTemplateContextType_variable_description_getterfieldtype));
 			addResolver(new CodeTemplateVariableResolver(FIELD, JavaManipulationMessages.CodeTemplateContextType_variable_description_getterfieldname));
@@ -319,8 +319,8 @@ public CodeTemplateContextType(String contextName) {
 			addCompilationUnitVariables();
 			fIsComment= true;
 			break;
-		case SETTERCOMMENT_CONTEXTTYPE:
 		case MARKDOWNSETTERCOMMENT_CONTEXTTYPE:
+		case SETTERCOMMENT_CONTEXTTYPE:
 			addResolver(new CodeTemplateVariableResolver(ENCLOSING_TYPE,  JavaManipulationMessages.CodeTemplateContextType_variable_description_enclosingtype));
 			addResolver(new CodeTemplateVariableResolver(FIELD_TYPE,  JavaManipulationMessages.CodeTemplateContextType_variable_description_getterfieldtype));
 			addResolver(new CodeTemplateVariableResolver(FIELD, JavaManipulationMessages.CodeTemplateContextType_variable_description_getterfieldname));
@@ -418,7 +418,6 @@ public void validate(String pattern) throws TemplateException {
 		}
 	}
 
-
 	private boolean isValidComment(String template) {
 		IScanner scanner= ToolFactory.createScanner(true, false, false, false);
 		scanner.setSource(template.toCharArray());

org.eclipse.jdt.core.manipulation/core extension/org/eclipse/jdt/internal/corext/dom/TokenScanner.java

@@ -428,7 +428,7 @@ public int getLineEnd(int line) throws CoreException {
 
 	public static boolean isComment(int token) {
 		return token == ITerminalSymbols.TokenNameCOMMENT_BLOCK || token == ITerminalSymbols.TokenNameCOMMENT_JAVADOC
-			|| token == ITerminalSymbols.TokenNameCOMMENT_LINE;
+			|| token == ITerminalSymbols.TokenNameCOMMENT_LINE || token == ITerminalSymbols.TokenNameCOMMENT_MARKDOWN;
 	}
 
 	public static boolean isModifier(int token) {

org.eclipse.jdt.ui.tests/ui/org/eclipse/jdt/ui/tests/quickfix/QuickFixTestSuite.java

@@ -58,6 +58,7 @@
 	JavadocQuickFixTest.class,
 	JavadocQuickFixTest9.class,
 	JavadocQuickFixTest16.class,
+	JavadocQuickFixTest25.class,
 	ConvertForLoopQuickFixTest.class,
 	ConvertIterableLoopQuickFixTest.class,
 	ConvertIterableLoopQuickFixTest1d7.class,