Don't warn about missing Javadoc tags
These changes turn off Eclipse warnings for Javadoc comments with missing tags, such as "@throw" or "@param". We don't turn this warning off in all projects. Rather, we turn it off only in projects that were producing at least one such warning. In other words, if a project was already completely "clean" with respect to this warning, then we leave this warning enabled for that project. Turning off these warnings is a partial declaration of Javadoc bankruptcy. In an ideal world, we would enable and fix all of these warnings. However, there are 327 of them. Apparently the WALA team's implicit coding style says that omitting Javadoc tags is OK. If there's no intent to systematically add these tags, then we may as well turn off these warnings so that we can see other warnings that we may want to fix.
This commit is contained in:
parent
49f08acb13
commit
98d5c02280
|
@ -8,4 +8,5 @@ org.eclipse.jdt.core.compiler.problem.enumIdentifier=error
|
|||
org.eclipse.jdt.core.compiler.problem.missingJavadocComments=ignore
|
||||
org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=public
|
||||
org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=no_tag
|
||||
org.eclipse.jdt.core.compiler.problem.missingJavadocTags=ignore
|
||||
org.eclipse.jdt.core.compiler.source=1.7
|
||||
|
|
|
@ -23,6 +23,7 @@ org.eclipse.jdt.core.compiler.problem.missingJavadocComments=ignore
|
|||
org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=public
|
||||
org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=return_tag
|
||||
org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsNotVisibleRef=disabled
|
||||
org.eclipse.jdt.core.compiler.problem.missingJavadocTags=ignore
|
||||
org.eclipse.jdt.core.compiler.problem.potentialNullReference=ignore
|
||||
org.eclipse.jdt.core.compiler.source=1.7
|
||||
org.eclipse.jdt.core.incompatibleJDKLevel=ignore
|
||||
|
|
|
@ -8,5 +8,6 @@ org.eclipse.jdt.core.compiler.problem.enumIdentifier=error
|
|||
org.eclipse.jdt.core.compiler.problem.missingJavadocComments=ignore
|
||||
org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=public
|
||||
org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=no_tag
|
||||
org.eclipse.jdt.core.compiler.problem.missingJavadocTags=ignore
|
||||
org.eclipse.jdt.core.compiler.problem.potentialNullReference=ignore
|
||||
org.eclipse.jdt.core.compiler.source=1.7
|
||||
|
|
Loading…
Reference in New Issue