eclipse-jdt/eclipse.jdt.core

[18] False javadoc warning when using snippets and validate Missing Tag: "Description expected after @snippet"

Open

#1583 aperta il 10 nov 2023

Vedi su GitHub
 (7 commenti) (3 reazioni) (0 assegnatari)Java (183 fork)auto 404
bughelp wantedjavadoc

Metriche repository

Star
 (233 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

If javadoc validation is turned on and a @snippet tag is used with the below setting JDT will give a warning.

Screen Shot 2023-11-10 at 9 00 28 AM

Description expected after @snippet

Here are the javadoc prefs:

org.eclipse.jdt.core.compiler.problem.invalidJavadoc=warning
org.eclipse.jdt.core.compiler.problem.invalidJavadocTags=enabled
org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsDeprecatedRef=disabled
org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsNotVisibleRef=enabled
org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsVisibility=public
org.eclipse.jdt.core.compiler.problem.missingJavadocComments=warning
org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=disabled
org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=public
org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=all_standard_tags
org.eclipse.jdt.core.compiler.problem.missingJavadocTags=warning
org.eclipse.jdt.core.compiler.problem.missingJavadocTagsMethodTypeParameters=enabled
org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=disabled
org.eclipse.jdt.core.compiler.problem.missingJavadocTagsVisibility=public

The below is the problematic setting.

org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=all_standard_tags

Guida contributor