From 1198054650a48d0b7b2a08097eed63a357de5a48 Mon Sep 17 00:00:00 2001
From: Ruslan Diachenko <rd.ryly@gmail.com>
Date: Sat, 29 Aug 2015 21:22:42 +0100
Subject: [PATCH] Issue #1566: 'missing javadoc comment' violations fixed in
 AbstractJavadocCheck

---
 .../checks/javadoc/AbstractJavadocCheck.java  | 38 ++++++++++++++++++-
 1 file changed, 36 insertions(+), 2 deletions(-)

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 565286d0b..bdabdee75 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
@@ -192,6 +192,10 @@ public abstract class AbstractJavadocCheck extends Check {
 
     }
 
+    /**
+     * Getter for block comment in Java language syntax tree.
+     * @return A block comment in the syntax tree.
+     */
     protected DetailAST getBlockCommentAst() {
         return blockCommentAst;
     }
@@ -562,6 +566,10 @@ public abstract class AbstractJavadocCheck extends Check {
          */
         private ParseErrorMessage errorMessage;
 
+        /**
+         * Getter for error message during parsing.
+         * @return Error message during parsing.
+         */
         private ParseErrorMessage getErrorMessage() {
             return errorMessage;
         }
@@ -634,18 +642,34 @@ public abstract class AbstractJavadocCheck extends Check {
          */
         private ParseErrorMessage parseErrorMessage;
 
+        /**
+         * Getter for DetailNode tree.
+         * @return DetailNode tree if parsing was successful, null otherwise.
+         */
         public DetailNode getTree() {
             return tree;
         }
 
+        /**
+         * Sets DetailNode tree.
+         * @param tree DetailNode tree.
+         */
         public void setTree(DetailNode tree) {
             this.tree = tree;
         }
 
+        /**
+         * Getter for error message during parsing.
+         * @return Error message if parsing was unsuccessful, null otherwise.
+         */
         public ParseErrorMessage getParseErrorMessage() {
             return parseErrorMessage;
         }
 
+        /**
+         * Sets parse error message.
+         * @param parseErrorMessage Parse error message.
+         */
         public void setParseErrorMessage(ParseErrorMessage parseErrorMessage) {
             this.parseErrorMessage = parseErrorMessage;
         }
@@ -684,18 +708,28 @@ public abstract class AbstractJavadocCheck extends Check {
             this.messageArguments = messageArguments.clone();
         }
 
+        /**
+         * Getter for line number where parse error occurred.
+         * @return Line number where parse error occurred.
+         */
         public int getLineNumber() {
             return lineNumber;
         }
 
+        /**
+         * Getter for key for error message.
+         * @return Key for error message.
+         */
         public String getMessageKey() {
             return messageKey;
         }
 
+        /**
+         * Getter for error message arguments.
+         * @return Array of error message arguments.
+         */
         public Object[] getMessageArguments() {
             return messageArguments.clone();
         }
-
     }
-
 }