From 8046febbdfef60b63a5f9e023963d70c853a8f09 Mon Sep 17 00:00:00 2001 From: Michal Kordas Date: Sat, 8 Aug 2015 12:13:33 +0200 Subject: [PATCH] Fix Javadoc problems. #1555 Fixes `JavaDoc` inspection violations. Description: >This inspection points out the following javadoc comment flaws: - no javadoc where it is required - required tag is missing - invalid or incomplete tag - javadoc description is missing or incomplete --- .../com/puppycrawl/tools/checkstyle/api/JavadocTagInfo.java | 5 ----- .../checkstyle/checks/javadoc/AbstractJavadocCheck.java | 2 -- 2 files changed, 7 deletions(-) diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/api/JavadocTagInfo.java b/src/main/java/com/puppycrawl/tools/checkstyle/api/JavadocTagInfo.java index b13361992..15899870f 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/api/JavadocTagInfo.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/api/JavadocTagInfo.java @@ -411,11 +411,6 @@ public enum JavadocTagInfo { * given AST. * *

- * For example: Given a call to - * JavadocTag.RETURN{@link #isValidOn(DetailAST)}. - *

- * - *

* If passing in a DetailAST representing a non-void METHOD_DEF * true would be returned. If passing in a DetailAST * representing a CLASS_DEF false would be returned because diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/AbstractJavadocCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/AbstractJavadocCheck.java index d39da6dc2..95de7da64 100755 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/AbstractJavadocCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/AbstractJavadocCheck.java @@ -430,8 +430,6 @@ public abstract class AbstractJavadocCheck extends Check { * @param blockComment * block comment content. * @return parse tree - * @throws IOException - * errors in ANTLRInputStream */ private ParseTree parseJavadocAsParseTree(String blockComment) { final ANTLRInputStream input = new ANTLRInputStream(blockComment);