TouchInstinct
/
checkstyle
311
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Issue #2141: Allow @return tags from annotation types

This commit is contained in:
Phillip Webb 2015-09-07 22:37:23 -07:00
parent 66b07f10af
commit f7698ed23b
3 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.java
View File

@ -482,7 +482,10 @@ public class JavadocMethodCheck extends AbstractTypeAwareCheck {
}
final Iterator<JavadocTag> it = tags.iterator();
if (ast.getType() != TokenTypes.ANNOTATION_FIELD_DEF) {
if (ast.getType() == TokenTypes.ANNOTATION_FIELD_DEF) {
checkReturnTag(tags, ast.getLineNo(), true);
}
else {
// Check for inheritDoc
boolean hasInheritDocTag = false;
while (it.hasNext() && !hasInheritDocTag) {

6
src/test/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheckTest.java
View File

@ -141,7 +141,6 @@ public class JavadocMethodCheckTest extends BaseCheckTestSupport {
"262:8: " + getCheckMessage(MSG_UNUSED_TAG, "@param", "aParam"),
"320:9: " + getCheckMessage(MSG_JAVADOC_MISSING),
"329:5: " + getCheckMessage(MSG_JAVADOC_MISSING),
"333: " + getCheckMessage(MSG_UNUSED_TAG_GENERAL),
};
verify(checkConfig, getPath("checks/javadoc/InputTags.java"), expected);
@ -177,7 +176,7 @@ public class JavadocMethodCheckTest extends BaseCheckTestSupport {
"262:8: " + getCheckMessage(MSG_UNUSED_TAG, "@param", "aParam"),
"320:9: " + getCheckMessage(MSG_JAVADOC_MISSING),
"329:5: " + getCheckMessage(MSG_JAVADOC_MISSING),
"333: " + getCheckMessage(MSG_UNUSED_TAG_GENERAL), };
};
verify(checkConfig, getPath("checks/javadoc/InputTags.java"), expected);
}
@ -285,7 +284,7 @@ public class JavadocMethodCheckTest extends BaseCheckTestSupport {
"262:8: " + getCheckMessage(MSG_UNUSED_TAG, "@param", "aParam"),
"320:9: " + getCheckMessage(MSG_JAVADOC_MISSING),
"329:5: " + getCheckMessage(MSG_JAVADOC_MISSING),
"333: " + getCheckMessage(MSG_UNUSED_TAG_GENERAL), };
};
verify(checkConfig, getPath("checks/javadoc/InputTags.java"), expected);
}
@ -576,4 +575,5 @@ public class JavadocMethodCheckTest extends BaseCheckTestSupport {
};
verify(checkConfig, getPath("javadoc/InputJavadocMethodIgnoreNameRegex.java"), expected);
}
}

2
src/test/resources/com/puppycrawl/tools/checkstyle/checks/javadoc/InputTags.java
View File

@ -330,7 +330,7 @@ enum InputTagsEnum
int A_CONSTANT = 0;
/** Some javadoc. */
int B_CONSTANT = 1;
/** @return This tag is not valid here */
/** @return This tag is valid here and expected with Java 8 */
String someField2();
}